From ae50fb44a4168437e10b312ec966c6496fbbeeb8 Mon Sep 17 00:00:00 2001 From: Andrea Bogazzi Date: Thu, 30 Jul 2026 00:17:01 +0200 Subject: [PATCH 1/7] feat(demos): add cropping controls demo Add a demo page for the cropping controls shipped in `fabric/extensions`. - First canvas assigns both control sets side by side, so they are live without any toggling: `createImageCroppingControls()` as a full replacement, and `createImageResizeControlsWithScaleToCover()` merged into the default set as the four side handles. - Second canvas shows `enterCropMode` on double click, which is where the ghost of the full source image comes from. `renderGhostImage` is not exported, so the ghost cannot be enabled for controls you assign yourself. - The page documents what each set contains, how to assign or merge them, and why `padding: 0` matters for the handles that scale the source inside the crop window. Bump fabric to ^7.4.0: the cropping edge-resize helpers (`createImageResizeControlsWithScaleToCover`, `withFlip`) are not present in the previously installed 7.0.0-rc1. Expose `fabric/extensions` to demo snippets as `extensions`, since the editor evals the code and cannot use imports. The helpers are imported by name rather than as a namespace: a namespace object assigned to `window` keeps every export alive and pulled the westures gesture integration into the client bundle. `westures` is added as a devDependency because the extensions barrel imports it unconditionally and fabric declares it nowhere, so module resolution fails without it. Also add AGENTS.md, symlinked as CLAUDE.md, describing the repo layout and the demo authoring conventions. Co-Authored-By: Claude Opus 4.8 --- AGENTS.md | 105 ++++++++++++++++++ CLAUDE.md | 1 + package-lock.json | 18 ++- package.json | 5 +- src/components/CodeEditor/index.jsx | 42 +++++++ src/content/demo/cropping-controls/code.js | 84 ++++++++++++++ .../demo/cropping-controls/cropMode.js | 55 +++++++++ .../cropping-controls/cropping-controls.jpg | Bin 0 -> 70050 bytes src/content/demo/cropping-controls/index.mdx | 104 +++++++++++++++++ 9 files changed, 407 insertions(+), 7 deletions(-) create mode 100644 AGENTS.md create mode 120000 CLAUDE.md create mode 100644 src/content/demo/cropping-controls/code.js create mode 100644 src/content/demo/cropping-controls/cropMode.js create mode 100644 src/content/demo/cropping-controls/cropping-controls.jpg create mode 100644 src/content/demo/cropping-controls/index.mdx diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..32e75bf8 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,105 @@ +# AGENTS.md + +## What this repo is + +Source for **fabricjs.com** — the marketing site, docs, demo gallery, and +API reference for [Fabric.js](https://github.com/fabricjs/fabric.js) (an +HTML5 canvas library). Built with [Astro](https://astro.build) using the +[Starlight](https://starlight.astro.build) docs theme, plus React islands +for interactive bits. Deployed to GitHub Pages. + +This is a documentation/marketing site, **not** the Fabric.js library +itself — the library source lives in the `fabric.js` git submodule and is +only used here to generate the API reference via TypeDoc. + +## Repo structure + +``` +/ +├── fabric.js/ git submodule → fabricjs/fabric.js (library source) +│ used only as TypeDoc input for the API reference; +│ not built/bundled into the site otherwise +├── src/ +│ ├── pages/ Astro routes: index, demos, resources, team, 404 +│ │ └── demos/[...slug].astro renders each entry from the `demo` collection +│ ├── content/ +│ │ ├── config.ts defines the `demo` and `docs` content collections +│ │ ├── demo/ one folder per interactive demo: +│ │ │ index.mdx (frontmatter + ), code.js, thumbnail +│ │ └── docs/ Starlight-schema docs (guides + API reference) +│ │ ├── docs/ hand-written guides (getting started, cropping-images, etc.) +│ │ └── api/ TypeDoc-generated API reference (auto-generated, do not hand-edit) +│ ├── components/ Astro/React components (CodeEditor, Header, Card, TeamMember, ...) +│ ├── layouts/ Layout.astro + global CSS +│ ├── css/ additional stylesheets +│ └── utils/ +├── public/ static assets (favicon, images, etc.) +├── astro.config.mjs Starlight sidebar, TypeDoc integration, redirects +└── .github/workflows/ build.yml (PR check), deploy.yml (push to main → GitHub Pages) +``` + +## Key mechanics + +- **Content collections** (`src/content/config.ts`): `demo` (interactive + code demos, schema: title/tags/thumbnail/description) and `docs` + (Starlight's schema, covers both guides and API reference pages). +- **API reference generation**: `astro.config.mjs` runs + `starlight-typedoc` against `./fabric.js/fabric.ts`, but only if the + `fabric.js` submodule is checked out locally (`fs.existsSync` guard) — + this lets `npm run dev` work without the submodule, skipping API docs. +- **Demos**: each demo is a folder under `src/content/demo//` with + an `index.mdx` that imports `code.js` as raw text and renders it inside + `` (a React island using CodeMirror) next to a live + ``. Demo routing is handled by `src/pages/demos/[...slug].astro`. + A `thumbnail` image must exist in the demo folder — the gallery resolves + it via `import.meta.glob`, so a missing file fails the build. +- **Demo code scope**: `code.js` is `eval`'d, so it cannot use `import`. + `CodeEditor` injects a preamble exposing `fabric`, `extensions` + (helpers from `fabric/extensions`), and `canvasEl`. The snippet must end + up with a `canvas` variable — the editor stores it on `window.canvasesId` + for disposal between runs. + Note `CodeEditor` deliberately imports `fabric/extensions` with **named + imports** rather than `import * as`: a namespace object assigned to + `window` keeps every export alive and drags the westures gesture + integration into the client bundle. Add new helpers to both the import + list and the `window.fabricExtensions` object. +- **Sidebar**: configured manually in `astro.config.mjs` with + `autogenerate` pointing at `src/content/docs/docs` and + `src/content/docs/api`. + +## Working with the submodule + +The `fabric.js` submodule must be checked out for the API reference to +build. If it's missing/out of date: + +```bash +git submodule update --init --recursive +``` + +Without it, `npm run dev`/`build` still work but the `Api` sidebar +section won't be generated. + +## Commands + +| Command | Action | +| ------------------ | -------------------------------------------------------- | +| `npm install` | install dependencies | +| `npm run dev` | start local dev server at `localhost:4321` | +| `npm run build` | `astro check` (typecheck) then `astro build` → `./dist/` | +| `npm run preview` | preview the production build locally | +| `npm run astro ...` | run Astro CLI commands (e.g. `astro add`) | + +CI (`.github/workflows/build.yml`, `deploy.yml`) checks out the +submodule, runs the same Astro build on PRs, and deploys `main` to +GitHub Pages. + +## Conventions + +- Formatting via Prettier (`.prettierrc.json`: semicolons, single + quotes, 2-space tabs). `.prettierignore` excludes `fabric.js` and a + few content dirs. +- `src/content/docs/api/**` is generated output from TypeDoc — treat it + as build output, not hand-authored content (regenerated whenever the + submodule/docs build runs). +- Guides live under `src/content/docs/docs/**` as `.md`/`.mdx` with + Starlight frontmatter (title, description, etc.). diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 00000000..47dc3e3d --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 44d930e1..96f97ad4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,7 +22,7 @@ "astro": "^5.17.3", "canvas": "^3.2.0", "codemirror": "^6.0.1", - "fabric": "^7.0.0-rc1", + "fabric": "^7.4.0", "jsdom": "^26.1.0", "prettier": "^3.4.2", "react": "19.2", @@ -34,7 +34,8 @@ }, "devDependencies": { "typedoc": "^0.28.11", - "typedoc-plugin-markdown": "^4.7.0" + "typedoc-plugin-markdown": "^4.7.0", + "westures": "^1.1.1" }, "engines": { "node": "^20.3.0 || ^22.16.0 || ^24.8.0" @@ -4641,9 +4642,9 @@ "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==" }, "node_modules/fabric": { - "version": "7.0.0-rc1", - "resolved": "https://registry.npmjs.org/fabric/-/fabric-7.0.0-rc1.tgz", - "integrity": "sha512-g7tzg6kxD+7finYlmI6hbqLQx0IUCQc+BlpyC4eGqTw/bqf8OGSTSMHsd6OGx5OptWfnUlTiWWkJaPccgwKH9w==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/fabric/-/fabric-7.4.0.tgz", + "integrity": "sha512-NalYDc3eifTl1C33zryQwpH6+XA/2ClxQrH9vkASkZw3tbkRmorpikhYMmxhUTmi7O3e9ODz0vOT8qfaCh9IVA==", "license": "MIT", "engines": { "node": ">=20.0.0" @@ -9169,6 +9170,13 @@ "node": ">=12" } }, + "node_modules/westures": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/westures/-/westures-1.1.1.tgz", + "integrity": "sha512-lXXBn4rNpwJyIAXK9aLS9Fx61WFK9rfigcMavH37ApGwrfr7MHrkm6vMIkpIJ1dgkbMm+Ht2h7PbCpyItJu7lg==", + "dev": true, + "license": "MIT" + }, "node_modules/whatwg-encoding": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz", diff --git a/package.json b/package.json index 6a93ac4d..d6787df9 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "astro": "^5.17.3", "canvas": "^3.2.0", "codemirror": "^6.0.1", - "fabric": "^7.0.0-rc1", + "fabric": "^7.4.0", "jsdom": "^26.1.0", "prettier": "^3.4.2", "react": "19.2", @@ -40,6 +40,7 @@ "packageManager": "npm@10.8.1+sha512.0e9d42e92bd2318408ed81eaff2da5f78baf23ee7d12a6eed44a6e2901d0f29d7ab715d1b918ade601f72e769a824d9a5c322383f22bbbda5dd396e79de2a077", "devDependencies": { "typedoc": "^0.28.11", - "typedoc-plugin-markdown": "^4.7.0" + "typedoc-plugin-markdown": "^4.7.0", + "westures": "^1.1.1" } } diff --git a/src/components/CodeEditor/index.jsx b/src/components/CodeEditor/index.jsx index 635ecc4e..b39cd115 100644 --- a/src/components/CodeEditor/index.jsx +++ b/src/components/CodeEditor/index.jsx @@ -6,6 +6,28 @@ import { import { StateField, EditorState } from '@codemirror/state'; import { EditorView, basicSetup } from 'codemirror'; import * as fabric from 'fabric'; +// Named imports, not `import * as`: a namespace object assigned to `window` +// keeps every export alive, which drags the westures gesture integration +// (and its `westures` dependency) into the client bundle. Listing the +// helpers explicitly lets rollup drop the ones no demo uses. +import { + AligningGuidelines, + createImageCroppingControls, + createImageResizeControlsWithScaleToCover, + createLinearGradientControls, + enterCropMode, + changeCropX, + changeCropY, + changeCropWidth, + changeCropHeight, + changeWidthAndScaleToCover, + changeHeightAndScaleToCover, + withFlip, + installGradientUpdater, + installOriginWrapperUpdater, + gradientUpdaterWrapper, + originUpdaterWrapper, +} from 'fabric/extensions'; import { debounce } from '../../utils/debounce'; import { useCallback, useEffect, useRef, useState } from 'react'; import { espresso } from 'thememirror'; @@ -23,6 +45,7 @@ export const CodeEditor = ({ code: codeProp, children, canvasId, autoRun = true, } const preamble = [ `const fabric = window.fabric;`, + `const extensions = window.fabricExtensions;`, `const canvasEl = document.getElementById('${canvasId}');`, ]; // when click 'run me' button, makes code string change to trigger 'setCode' function. @@ -43,6 +66,25 @@ export const CodeEditor = ({ code: codeProp, children, canvasId, autoRun = true, // and add to window canvases for cleanup/restart // seems hacky, maybe it is, but it allow us to use the imported version window.fabric = fabric; + // exposed to demo code as `extensions` (see the eval preamble below) + window.fabricExtensions = { + AligningGuidelines, + createImageCroppingControls, + createImageResizeControlsWithScaleToCover, + createLinearGradientControls, + enterCropMode, + changeCropX, + changeCropY, + changeCropWidth, + changeCropHeight, + changeWidthAndScaleToCover, + changeHeightAndScaleToCover, + withFlip, + installGradientUpdater, + installOriginWrapperUpdater, + gradientUpdaterWrapper, + originUpdaterWrapper, + }; window.canvasesId = window.canvasesId || {}; // https://github.com/codemirror/dev/issues/44#issuecomment-789093799 diff --git a/src/content/demo/cropping-controls/code.js b/src/content/demo/cropping-controls/code.js new file mode 100644 index 00000000..ad89b2c4 --- /dev/null +++ b/src/content/demo/cropping-controls/code.js @@ -0,0 +1,84 @@ +const canvas = new fabric.Canvas(canvasEl, { + backgroundColor: '#f5f5f5', +}); + +// Both factories come from `fabric/extensions`: +// +// import { +// createImageCroppingControls, +// createImageResizeControlsWithScaleToCover, +// } from 'fabric/extensions'; +// +// In this editor they are pre-imported for you as `extensions`. +const { createImageCroppingControls, createImageResizeControlsWithScaleToCover } = + extensions; + +const shared = { + scaleX: 0.45, + scaleY: 0.45, + cropX: 80, + cropY: 80, + width: 400, + height: 400, + cornerColor: '#ffffff', + borderScaleFactor: 2, + transparentCorners: false, + padding: 0, +}; + +const label = (text, left, top, fill) => + new fabric.FabricText(text, { + left, + top, + fontSize: 14, + fontFamily: 'sans-serif', + fill, + originX: 'center', + selectable: false, + evented: false, + }); + +const imageUrl = '/assets/dragon.jpg'; + +Promise.all([ + fabric.FabricImage.fromURL(imageUrl), + fabric.FabricImage.fromURL(imageUrl), +]).then(([cropped, resized]) => { + // Replace the whole control set: every handle now moves the crop window + // instead of scaling the object. + cropped.controls = createImageCroppingControls(); + cropped.set({ + ...shared, + left: 210, + top: 250, + cornerStyle: 'circle', + cornerStrokeColor: '#7c3aed', + borderColor: '#7c3aed', + }); + + // Keep the default controls and swap in only the four side handles. + const edge = createImageResizeControlsWithScaleToCover(); + Object.assign(resized.controls, { + ml: edge.mle, + mr: edge.mre, + mt: edge.mte, + mb: edge.mbe, + }); + resized.set({ + ...shared, + left: 590, + top: 250, + cornerStrokeColor: '#0284c7', + borderColor: '#0284c7', + }); + + canvas.add( + cropped, + resized, + label('createImageCroppingControls()', 210, 380, '#7c3aed'), + label('drag any handle to move the crop window', 210, 404, '#64748b'), + label('createImageResizeControlsWithScaleToCover()', 590, 380, '#0284c7'), + label('drag a side handle to resize, corners still scale', 590, 404, '#64748b'), + ); + canvas.setActiveObject(cropped); +}); diff --git a/src/content/demo/cropping-controls/cropMode.js b/src/content/demo/cropping-controls/cropMode.js new file mode 100644 index 00000000..07006adb --- /dev/null +++ b/src/content/demo/cropping-controls/cropMode.js @@ -0,0 +1,55 @@ +const canvas = new fabric.Canvas(canvasEl, { + backgroundColor: '#f5f5f5', +}); + +// import { enterCropMode } from 'fabric/extensions'; +const { enterCropMode } = extensions; + +// Note: read the size from the canvas, not from `canvasEl.width` — fabric +// rescales the element by the device pixel ratio when it takes it over. +const center = { x: canvas.getWidth() / 2, y: canvas.getHeight() / 2 }; + +canvas.add( + new fabric.FabricText('Double-click the dragon to enter or exit crop mode', { + left: center.x, + top: 16, + fontSize: 14, + fontFamily: 'sans-serif', + fill: '#334155', + originX: 'center', + selectable: false, + evented: false, + }), +); + +fabric.FabricImage.fromURL('/assets/dragon.jpg').then((image) => { + image.set({ + // A 500x500 window centred in the 1920x1200 source, so the ghost of the + // full image renders centred on the object once crop mode is entered. + cropX: 710, + cropY: 350, + width: 500, + height: 500, + left: center.x, + top: center.y + 10, + originX: 'center', + originY: 'center', + scaleX: 0.35, + scaleY: 0.35, + cornerColor: '#ffffff', + cornerStrokeColor: '#7c3aed', + borderColor: '#7c3aed', + borderScaleFactor: 2, + transparentCorners: false, + cornerStyle: 'circle', + padding: 0, + }); + + // enterCropMode installs its own dblclick handler to leave crop mode again, + // so registering it once is enough to toggle back and forth. + image.once('mousedblclick', enterCropMode); + + canvas.add(image); + canvas.setActiveObject(image); + canvas.requestRenderAll(); +}); diff --git a/src/content/demo/cropping-controls/cropping-controls.jpg b/src/content/demo/cropping-controls/cropping-controls.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5c024efad3fd31a00df669edb59e8c25f0880500 GIT binary patch literal 70050 zcmbTdWmp_d*flt~27(2bAR)osC6M3&g1fsr3~m8J@WFyZa1ZV-gF6iFFi4QWWq{>* zclZ1L?2p|&-CbQ*S9Nut>bvWzI(65};>#xBt-Q3HGynks0FZs%054mBZ&E-TO8`Jo z5x@ih0MG#l5jFti*Vt)HnMf|^05#n=^{&)Ppj4#~)JamM3 zgm@$bS^y#*0umm=OFw}6^-dIo|G|Hm{sRIc5;6)Z8af6h)@z1_w*W*0BqT&+Boq|n z*GD7xzor9_@lf#Jb4s8RsF&C*+~iN!IibsZO8MbDO$`U|_x@CLtwb_`vw_ z6B7?FAHRU0(3h`L(lWAg@@ncDnp)aAx@P7UmR8m_wr=hoo?bw2pU@v+;SoP0e}NK{ zl2cNDr=|bNFDNW3E-5Xmt*dWnY-(<4?d|Iy7z7UukIc-@%`ZR}mzKA-cXs#op$CUY zu#3y9>zmuV`-lH{z1GVAN$WNIf8>St$_o)083`HfKVArkUjGrtLq>VeiHa|wf@b1E zK+6@3PAHj>SJQ(*$E|u!Wa>JN`Hr4vivji@wf|xE|BhJ5|1W0$i`f6>wF3A8K>Qyd zAtEB7AR!^4prX726&>|Ipkt!{4>12PVE+$r{sZp+!pmzR2(M)zBO{}|?r*U$u-^WE z#>?8Pagn|(1F(@0UX2L}4cN%{MpOPC69e3vai1btvxE{2^58>oaR<<%v*?)p_Zav6Gtx|nEwLLmi}FP@UT9|G zxQCEk5jcyyZjqP$-RhBRgckM3!zq|1&zj-GQi?adh&$j0emqdwAfragnn|$MRBs;Ic>z@GL&E%Q zQ$WU9B}#nRZiZo~9l5q{Z7J$WA#0z}5L+x1%ge2u$eQYo3^LRj;-Bv^EJ#QX<6tFh z`%`0BES#kocb&;OZyV-*L}7&k{5tNh9w2m-S@71-FSw&~6tSGgI)mv~Olko|DfyIz z2XUj{*KYn&P}^>wxtqs~?Gct!Va4_}pBR|8daUAJS|o@^iI3D?XDrTeHiU9T8~b=x zr8}-rTo_D}!ibVuT`OwF7_ePO#3K&uvTCv~t{tsnxu$eVKwEbRZ$qOKXNB#i&equS z#cY|GKSG_pto%n%&xUw;`&dXUHj0)bT+pvqm3P_e9kLbF$PYGPU|WTEDa1hnoX;w# z7h%@zP&6Cx^jdI){88LD{;4&>1i+fq0K{cnl`o{OljLZmK-F}r_P(8Wv6z26jCZSd zKb+J(r?U%jRdU{l$iRO>MXvaRz1R5bb$``znm^M$i9n10XSNWOUf5^C-@ zYi>`g0UEnvs56~C)*x=#9J^7u=-?0pB=Ia;+jRJhj3;aR@O!t%VN{MP^(|t7O@v9R zc`%CSzL}xOJfYT?iQ;Brwf2~-O1h6??GBV32#1>PH56{03rxkkli%>gALe5S4~e2e zZ)cHxpo`yAQPI;PM@2?Fv%6h^d6F>En2y;itxe1PY9lz8g}+4Sq!Z;3a7dqvlP%ZS z9hRq6a{p$@(9*Yma=E6o4k z=FNRl=9_#kWVeYoJ|Z_YJyh9Ec=!AY-fq?xG8ZSyL^TkSkr#mOR-eR&NoJ1Z3=ytV z-!=sYd8=l<6M3w|rf+g%op#w2*+wFpJ9N1_g7>N5TNm5q$!x%55pBn3V~L*0V%}?L zq{E6r#~l7)f4+*>viajU+n&c0X-(|)#S0+r>ewBI{0s0EBrzd4WR!8QnV4$U#*}^& zQ*U)g-k*}9l>)MTH_`LQEG*GvReFl#GB~>#N}c5&b8fVQlj5iMF4enG$}Ygfy(ybN zTb-*cmAW-y=?h*wh1*JpA8Id&2eUTCzstN;p&c5RoKom=2V<|#uNB~qOq-k}0*}R_ z@sHhvo}obj+S*K>)hkW`VAHtSjWon4$^eF~`^`uAO`csV zghO!kwPG}r(jB453|QJ%)bHRLF!sJTXo_?7$C0`Nek-5$8OLP{nGDx0rAJ!d`WRE- z-~g+fdN;`7a*vXSw>dZ>5)8@VE&0k0B{u2fwLcXb^Kj2ttBBc0njV@E0xT@`-3;8; zmyUHS&-$_~N0xV_eoggjhs-G8x0W%3B*wnR%7}7E`3XLPBp7S4Ra zFA4iWww}S#$LY=b_VY9m_C!US4C$)x_TOTox~u2T9ie(*R$TNbm1b|#S{PC5x(=8> z)dd^$YR*zyjz%`409=x*YNhkDX!iOw>7CwI%N!?iYKDH#X+jyDpot5)$Cg34L2;&t z{%5S(8oP`&O*J#8K&CZ{7JMFOc40iN!-TfkLv?rbQ;%c8cDce(qRh4nohGG&77Z3> zz7sHJyYXfEx(D6p_!P8QNgrPBmI})W@d(5{>OU$)PHC#RSQ$kZVOIsk2B+3p?NeP# zV(F;|)o}oPZf++#eAk|?(q$qlSkLmvf*FF?Q|aQ=hHq}F)1BN`j_t}T#XLF331>bU zrs>0@IpGYl1O7M~zdX!_`K#S_FIPKMQbjbQA-^6@1wE?(@E3rH))zb967I6Gu2#dH zrX53ItxYFU*jdBlo^tAYonDYz5Qf?7*U}C?vV%HB=F~3~i>6Kcy|<+SsqH@HhQ7B! z=&Qin(v|+^+K;@8mtcrS081f2e98vpSUlu-Y@LOX7I`xWu*rMfjjFC;az$bVfVK>6DlT(b<#n zqmsAUB_vB5&iMlPk*fY0B!V4S$Cg&jQdBSG$K$RG;Q330#y(c*x4vF_vhNla#FBl#27&yM~;y4VFBSFg*1m{+5XhPTEhFT9VXZ2Jwud5~ z8%&S69Agp_5@Ie2Jkk8ndNFIxytn({{sJJIc#1AFEmLra9_Bf40H-kmT;+~LF9LgC z`z&t>8-F6j7MQ1}YozZwn1TG`sNh!*^S>)Mo1zmhyZqeY4+|sgr6LQfJqkLG5oxY+ zlLC}-rI^FyL@|7Es@yY;RIU-DG**vMnZ^(4CQV+{;zJk*Xw@zIrAv-BCk`#K?^Rc- zNII3PT%MR_c}!g1vd7s!CpV{mwdJ4C&`=66dwA41t6TnzD@eLSp{XRz)t~<|6=68z zuwxOsgv`-jP9{at`=@%OtV{?634jyQ?3=+I&I}1nzh09ja8{ad8=55QGs^q%*W?;* zchjF-FP@^l=UW$H3fmQ!cvTb3yuA=H=F39XM8dS`}eP> zfV;2S4QXNcQ=7YpX zi3#OG7YPVj$%o%HoG1_hwdg0CMZW~m45hn7ui~6FrcR~Lx7X#aezL6~Wg-5hedo`| zhGYh?Nyp!3N(z54kS|1S^}o;I7Hr-{Ky6+C#zU7F6aI=OhDRx>;%yTY(Rgz;)x?eM z_B)vmzfS#lVYH(?siPU%r`H%J%{h}ETp0o;(#s>c{9_j`AOV%^2wozqVe&tJ??@MN zm_*5Ddt2KM-Huz^2^MV@M#w)Q$?*gs26|>qQebvd(cF2tn4m`H%DEt}Pt2@F?#dQ- z@3x%@3J!W!+heO6VmuZ5Y58;Cd5)YZcFg_SpC3--_G4ms}qY{V3(TwsW| z%5&8T?!_QaOLVtXdMk!tks7BWGztBan;`c#*}b_BzlamOz^I!S4#SV#&doiWnU7j( z#dc&kHC}G4h5ul-F7?sxJn_1xjkgj5O^S?P6Xe=(*J8B#wT0m$0 zIZQH=wvR5clj(6d)51UnZ7&z7Qny&PX?iEbyx!4c1N~Y1yV$rHiHR>E7~J5Tx}3z< z$ZQQtdscftX$bu8KdF0N={uOpsoR)kgHqN#;~+~LssHE3V3$gnv|I3ibD@=$dn@b( z&@W7G5cqv2wa;@3P>cEve;5vQToiE>p|~zo`r}gn%|zUC_2}Ou;`vR4mlsKU2S^yW zOT(VN*qhCTup7LA*gNWT%xz4Ojv$ZN4~ zXp2(Y?H$6-`6No(OxYqp$${ek9xeKrboAy8`@e)$U3!MKLe(~%PE|s)y<@PrZaOF- zeW2}K&rhtd@HU5M? zI589=7Ro!gc0fgVZdoc~NSb0(;lUirr>i(tafDd3>5Z02wf1E9r*r1ak*8dyIc?!! zo$mfeI34C^K@nrj{fy(q)?~thv$+f9XtMsqRU3tZ)L(ME=)Hasz>7a`K^%#Mup^bzu06qS1C(Wz-~1^e0#C%@k)kdNYzuJg{y4 zRt(OPh=Y&gy6g*}&Owz{WyAzF%veehz?;nQX;iI6KqV~IY3zQdzfskOiZNB%rQ;vr z*9rkflA%c_SoyLm7$?8LmLTU7UADMLHA;~Eg^XL=NXGVJz+^f7F&(!YO?(~x*w-}1 z#Kazw!fbr^d&z9&Gqicsot2q}l#*-0j>Vj!#s?n!yFa4?WExkItc5Wd!}i+0hvX8h z7)eLAjYk55PAPGiM^DdAJ*bI*ql%51KsKuFi#cJ+Uj~tQClg3$l3%bruB&#o{y}Ph z#eHOLLx$@PG<{x9P4o-{{Y(|gMF*Yz=^Zg~>-xx?Yl`@Zpp9q& z`IXLFAhqO4Tw*W6ghNK{FQv;z(;>*)-^BeB`xDue1@~F}-Hh;8)@-TX+-2EqtFUnP z;N;VPN->48XAfj0OVCB^R3moA&7EHRWA&5Cgg7wL8DP`>LO(yT3`m%z6%}@ihK5;T&l|RmGpYHr9 zM*ZIhhTX4zHxSLo_O#%mQQ8tw?>?M{utHniIcl_eh2sT$!vSQ(t)V>?2WbderbWO0 zlU-GvLY6qVwW^^^x1%AY(6vTETzky|gGDtoGn7E!&GS$|OLfAaDTDl<%*KwiQ`KHc z7ne}TVJ}zX>ZBdp>oL#={{07Nk3#phXDNTZlHdZ6@ zK8WgCp%14uAkOApkx1$+dqJ$Gs4G7ohi`PeSV#xCM55H3{Y1WLwK<#VFaKCBK0ZB0 z$|r9y(Mn|UpPgAZ3L^2qG$*?N8RAmb`Gw!*v`x$Gj(|ob=e&5PIEf$}|JPPC_60x! zC)nyx7E;`tYw#rp8qbMM)~aD)$8iaa=KYS1so(Sxl`?srp|0PL+{&j8g0o^5=3S6^ zQ_=_NugIQ|XV@g|Nk+rLXKu0FIpYN|!>;lbT_ZbUS6lvc$%fACi})F*W{05)9i^+N z=4X81b|%>S-m}bAaYO*RO8*LZrX*~7P&|3!vEPsm;wMqDYHimD)z0ck zt7A;2&>4DkZEIEdfUbtx{ZrlJX$$_g=bY@ zcPmP4s>2O>T49GXLrcQFjX`S)W3^}?)3q-UH;ER>ocfz1V`Tty`aV}FBT0wwt$3NU zjsXiRFFLa~5nj_6nM8Ij%3+SvWTo}jpf?pu^t(9C&qW1qW2sMf@*aFJvp=2m)>Wa- zf_7a4lD8SmiZsaY6dDtRwx;=@`5e%5N@jl<&~MLGaN^|UgO<1x5Q5vvK}67UYCF10 z*Rt}sAhP?kuBaL_ftj>oQQTsTDV^sWaO1LEN}3knyeL*&EtXU<+(&$`egW7Kk30Nc zF+H~XHEm@sUV*~bvn)nbKH8y_Mav~blddDqV7;qShh*Yg#v-iyOa&wV=l<7C*r3dT zl(pXQe%arjOjMr@m2kh^7JnGZXlx`Yt>3!`n@k1px~Ojo01#$B(54>Po!-j*erRb}cYpD0^TX)kG? z@Ob#zeYNUTCkFfrj5W8jX7=0nA!%@n3A(XwP=G1t1`)K?v(T!**12JPxFMdRw->?L zuV~A%#Rvjw0AWiv8cP{V17@P-IiKmrP4X=TTrKRuvz@8E9f9y~$HaMdI4+l3-nt z|Fo3;&Yd7NJY}xiv%1j@nL2-SB$9itebE-Q-E6Z{rtViGljmebKA|OIdb|bs0cS1v zLX;e;t+(tQNlNgywL?q%_*4lkb?QV4p^d`Dkab6qX;t=T*TK#C^EGGRzoFx6N+q|M zj^lo>*4S$7OZk#JMA`gRbM`^5JL=pC7f6G5T>qtmP3|gp0?R*yW$|!9Vn> z#f7rM^DFfyW^DN{CV6KI3Q1MWFQ&Cj0H@1>yXFfRMHLgPUQCIN&>Xl#(|O0qbz{Cs zQJ}f9Fxx@p*}GaD*7T!686Vhc zZJuB`>)!m;7ux);=BemQo8?xDGcn)0;~ zW!0vT2jceg)mxMHe`ySjt_5$U1Lt9jF5^A}Sr@kaX>uxORVxSt$!}ttCp<$$eKk%z zC%??`3`~Qhh+&_c=yS5nW9r(dBD{|EnesL0aQ07+@H2F&@z>S|O8q3-I%cdC3Yw%i zTbq}qWhow0sGnPR&lo$&x_+MKzLnysq)-CAPo*%w2h!2sh%y&X*9YPpyuL782Kgq& z0+ZfQH`f^9-u$S83mW9loHV;dOa}fbk_6Ja)H35nbg6dgZ{8tfHeofCV%N2Y)sN98zeSz+|Gxy>32oBgDCu9t-HX>&< znu&x-BwX)8ry%4MV(u$Zgsu|90!aH4%J$hoK9;phYgF|N<8OSZ^IrgH9-sa^er|6_ zIBgIWB4_3J${({Z&QevSv^Kdf`@`6sI{WOG`$q>44;WiADWiJRCB4S+e(ws2FNHbY zGtu4#dR~OwR6Qxnj+&>(&!S(_jIL;^(P$#5?_XyQoZIjyza9*EN%7v~E-|vn{NCW$ z2^|)@hO&sCdFQB&RqL(VP|3h>WoDg32TEn3ZWa=5E@f<;^NsyEpUNY5D8xJz=kV}VG2yW}LdkPd-& z45eVty_)BI`QF^jioCO5$MKUTD~5`#hv~wu%L~a32Y-9{)X$3LoNM(fwB-N}Zm2#? z7tiJ`*sC~<0kfI=LDZl4eqU%bm2JMoaTct$z61nj*~I4GT$fT=1}L+dgFcg@y`QIGb_RBz81cu3mXoU5LXP~!$Wy|!=M!5y!J}Qc zVq)5G)AN(-<8i8B7Zaah5n^PFxAgBd<#4zRVihR-cjDZ3H|m{EFskmzd(#=i{;^j5 zt7`bD3K%MOpU$O~)1&5!CNhsBHTDui8wn7CB^TwKcWv`ES)ug!Q%&Od1^p$Dr20Hf z1Dx2dA~N@UuV9RgU>LX^NNxB09&*}lVuiCf#U`5&vZBCLVOPfx3minNwukHqz#Tc+ z%lJ>FpR0%K9w0y3g+})xW3A+j(#Jg%6lXXcuN77vtM8J!9g7y^>G2JP*9`O$Gf$E> z9T;5%jFPSf6w7QO>6G)05q}Qrj${-hJIqtq#oK><)^|i>kVW<)YS{9{3dC90KWd$= z99_b%`LW1#;l@ldY#Lx{w&@G~b!&utQ2wTXp8*cG7l{pwmAOxAfl}O7$AB&07TvUp z=TVV1ud}CsLl*C5x5wD3tv2t!ZJHR3CK>w>4Wi#vJwUc`2iu~#?+AdOku26ZbMoEp zw5B#3Qofu1h?#`TGzwjne!Xb*&t^%Y^w);Oi7Y3+08%;ON{nG;YkL|GHqSDXF*{w+ zs&e7yDnlpx_~KXZW!FXTdYJEx&cjpbGMRHA`_+GlsCe-Hq6F`H3I4M)?EZ;2P2eW3 zD$Vz(X=D@ue~8<8wge^pX@b1=NXM~ua-y9}xPb38)uFa$@H?~b`~&P!HCYke+#e}i zK@ZUN&PHO+-e52?m2%+ZOx?sEcIu(~X)WYrWUFdYQQMug-i_Y4Z8xC?hRPQJ`-PZY z{ap`?hUtDC&|-0X0sf@#i>=WIn;m%Ptpi8#BIo~JBP(!yV0WlsgDtna@(zm{NkGJ7 z_qy~qH?tBf+!%*T=s6jev*5O%>+MaWr}e#KU|jk?6>h1`jFLi;)A(lUKQ8)fT_^9i zNvq9b#c|Kno@+ik-=W2mWFn$9Ep+z$(rRI}MMKN#5SMRtV3EXgvm)?8426FJbL71M z#I)A67UtYl#9SJl^4fVgpDOc@_|TB{KUTHC(ZvfL_58f<>|7=Ja&Mqjj;w3m4?%YG zY_EbI?z;FH&kza0bHQeFeKo8H8|gY~!boff|7}Pkld1FCfLxyJn(OD^$5S@nx5gHP9@!N(q|EFAzB!r9UK|@Wv0FQ2=)wWQO~~43+fQ3n?rNoCnaQhoTOh5Uo~WyNux^ifDN;+C86Jf z0iMh1Tgvoq2cK9Z*m3+0%WU574jFM+&0Y?;-uf^uon)I9pkFA7`r`N|{(9h7ou>J& z{&dde@~muoK1pTAx2(RH2gNVm57FKX&FxqoS5 z#lZ~B(9tj5wi3W(ADlZ@4)3vP+z=|WR-&%wV7&@=BaNHmms-}WdgfP>)*7=qH- zSvJB+%MJqsU<%f)(&>kVcR*bkJLJAGt}k}%8JrF)!R+J|;q*Bp^&$>VTWx|4Y(=i& zuwrS#Kt1gT8&XgDkD#4qCG$&^9cHxCBy3#y* z@KH@4!v+_tqC?MRswlR-#)N?qNhF54I8Lmq$CxIf;iXs6b2;_vhNaA7cQsaoy+A*1DTtys?^?_r99AUlRyI7t8RC1ER&Chhv zo33_~VsyG0227-EN>=mqdxXUCnW&@`nU}Ewn~>?{jwof6RWcU7gyXk=m`6F$V-DI{ zx`)Ztsc>-33}pHyLmxV>UjPwsg|cD7Ndz0K*h_b{9$|beX=0{sXp&!$x7tFoy+%s0 zCVm7}<1s{^~DvN9)(Eb)e}^GMn_k2=~V~J|C;u*SywO?T10$ zf|jFhkl=r4@(sR4cgo+wSnTT`Co*p}#8h4{)L3H<#mdzvp9jcR`~~Q_*;< zklMp#xj7!$iokl4*4QPG4VCy>1*q1G2IS2U%ekn&j26Z-IxeZ;VEk0OAo1RMF>RJo z!7(7n9cjJoT;)b?LN8m)gxz}1_(qIjhDVurp!lehv$@Xf=`Y!Z7`=F#sb7Pz`pG>Z zMPf8a^mv5Dv~va;r`a0xD&{VzFeAD|w*e4DJ9VGvVHyqpQrT^+9MHo*HZl!m%vr_y z3y9VjF+WcUX@tj7#aI}Je1sa8{oyEC3w_g}q(vzVu|Hb+M6$J;xk@I+55Z0)YoEm9 z_GP4 zL*nA%3X<5tqWU@JWg_)_u;MstW{Q{!}E zY^Ij5rl;t)D*Vj(Mxl)#LWKonGU4@6k^32ni7Fk9$?(~ZcV52)xuEn_Sf6^XtEXnS zVnpjtJa?p;tg9;VPlcT_lcV*95|N`lWmvYrlAMP|D9__QM5i^y$KQ`o-U-{0N9g;7 zlQNibSghUF`oh4xHyeE$#5PTxw6pa~)wip*UCRUmy#T4gG5XSplFvH;M-el&KpMOo|!L zXsyjqqc(`+PQ%odIx+3=mk~*m+jynEK?zDF-^~3Ex~cQ*JGmR*kls$p&dPDJv%|+B8iW>dN?AFzF9)jI>+1CR~#qp6MQyV|f?s4GnTf z2Zs5zxSU@Ob^?+c*b!`F=t)QQ1UKXI?)6~QF*b+PWZ4)ClY_11Da54I9X~0kT_Z|f z0Pc`9ma60Q(0!xGS&|l~;_KB1UFMM5pnF_KS1urQrNJG`+xjQ%H)b=C9*tGYxOZn( zwM}|Q*}4sJ&APOhsY>n6VrV#ZjGkV~TBFS9#b?p3!S>e3fu+iCWhQLb!dF0Df=}H@ zSsN!BUqnDANx|f}lZ=(FZvwrT|0T%hZX%5AY&<}u>|8;Towjf&C62(!iH>kbtj$)- z8(_iPXy$-h(p|II-;;!qE^ck4-A5RcM?R)?(KX}3X!e_%Ap$Re>xI<-eZG_6wrV;E z{I+6#0m?HUrFkhu$V6=8vg&pAFuRx${a1iw7b*^gRgjx*rR{G;kWz&fQ)sqZd;plA zh(u60-iXc1kxY=S;VE3uNaiI99uM<;9R(~OeT|DYD=C+yOZgUywxc>~zgzC{-Bnb% z2|6wum63<GTUBwgr;OvbPMU$Nt=tFEqoS_D9$XchoOFT*!0W0+<#}B=M-)Qj$t9w4 zgR`5T=-f_x(f**&g_OJQhX|KKnMN*G?==Ygs*o48ezip2=D22l*w+nrlr}yW;IG_L zb`nSh0N^oVHXq5o00`9CJEGB%uyd@bFZaD-Ox*5{m zd7MKCY?n`xI6|avY$$)4^_D=pjD;a6TZ;VKEK?1qtq{+t`hpDY0yJmAolngUq7rI% zvB`(a#bJz)E71=V-7f&kDB*^5*)z(FvG2w7cqxpG0<_I#il>vRVdw+PjPbyzP4*w~ zFL?%rcPOW(b0^cqzt(nHKn|qKWv}+0&EaN**T=dJs_~Y+@tSVr=(D3k#F73iIB0j> zIN9gZnc$qbG(egG8f&i-C7$w4zh}SseJ3S2x3cXJHc}YVZq1fU%^c2#x=V?>e%}_` z@j7DUUhg)oJXK%pQHU}*KU0Kh{iGh7%Xi@(be$2f0jPJ=Q?{VlkihNcjK&stM%nR> z(m^t;(I2cU=)S{*!cbDQhV~j^(VGvDNyLeZvmP%C0u`xs;yfMOk%hEC1mHcUe9`D`;7RVmSy&v@YG>Jy}-qxJJ8%~eVNV%52#GiD+fo@~X1zk5I_ z&`gku0?yI9!~=dJbkn#b82qtb_OH*?`$~WW3c}8Q>hOW28SyBrMHXT=zRE~}Tb*(C zh6l?muALgup}uC1eS*vDn@F+DbA_}2Od4gH)j#H2b5ZG0%Xc37L`Ct1Y2)rdsoF8m z*(1dm?h^g0#Dm={ab|9We`vz39gA}{-PvU6nz0%%+Y5lsga+`LQq*l+JwZea z`Y*NDLP1ANE9ny;n|qdy?y7>4(O~ZVd^L}^Mmk}<0&u*U4k4v5nhw*sgR^Mkjkd(2$YhmJf1B zfJsTjTB>sTsPNm)7ZO+-3t+1Tf|fRPs^x#Flic(-`d$D;$5`77=K+Q0qj*1uDMpG- zdUjDs)lSBJ!)x~RmWK>N&aSVjg^3Ld82_!b3jMwFQ7u0CQvu{Fw_{ihSNMU~T|p9U zChYU>?5a98&_*Ef`<#25_^047a=Ws`h{wL-Z*Jf%Bb~d;{*-LWn&yQnB-xs$d8#gn z;TyzGOxQw=TbZqu<~(T%Vy8EDq3oBb*Y@RAO|g+`J_1g~u`1%CEtqlXGp~vaTDx@k zIGTDR0Voh4yl>Vco%m9;C7;cY0#uz5l)kW?hSGJo$J@Z}vc1{TZ4`J$+CKo+K$110 zb&Fcwc3UKVGTYX09`kpX=wA!!>h=ZVJ_07V;W9I=X3A!|$^Ys_7Fz;}OCw@6}!4-{g*%r{RkJUd1{FI?JCOJ*71~u{*apls1%<0do(k3|T{QqZjT^ zw5-#9&A9LN9VaD~#o!uPsB;Y`(hkCM5hwg=>@3>IKjbE$j;sFD(IA^SPc4yUyR^f( z-FAuUMI#{6m#*+F)63#okaGo+w+n|`v*#{0w9#(&zVI)sE7rYyw;^_4u7Bp61Q)f? z(dPt2u7CsaaOM+XMWk;q@i6+o3pA0IwK4UNR;^!|YGoel5<@RTFZslAm>{87oLjzk zr}owMydR=`{Ih59J~lG`kTT9E*}P?>xUOQ<5Y)dpcs|16d!Ny(W}SLVhW3LF?@0II zCqu#pW&(YHUX4f);XCLCrJ_d)x6zTIIDriwRPNlNLddql6(GT&pj76PJYrTN(9=_S zHGSR8POZ}1m{4t@S|;0XLUL;IuY7*^M0*3>EU{ngJ*2D7iBAtqwIrs&>dFt&C&>1~ zcZoIwm=W!n79=Ju9U9w==>I(pFbJ4VP31Qffmw{*z>biQwK}!wD>$XKIjsO8dO*|m zSnicy_iFw8s^G1X`rYmv%}ggu0nR*}&tM7)Y%5X!N9P1eu!rn;&Ovf6Qv%?CaOUCh*KEiE2dgBjuD$!ljk??k)0j+Oo zOsD3l3JmzoyPcniXl&j)IoxL{)SODMX3pb=QgOD-R&8v(0Df-ZgvDftOZtNEZf>_b ziFpcYlGbU{Z+G$yrf&&3UI0t;&t=y|&+i_@Ca=UQ?UGF{+0+C{{skmY9tDuk@R|e9 zPG+2;4Co_?Pn;*eW@B_DyR^Wx4Ycmc@jG7jIB1oA1(rK!Qb+#CIc(rb-H6_m4mMbI zJDuMRG2R7X&C-h8g+AUqOQ!Az-J2)2p*i{a{O7H&lfoaxi9}9e_EAYjEMlQyYQ&3qke>33kFRBo zRfa(QKV6+4B$(l!)j@X?+*5834;rJsl_T$@aiDjNHxKU58e!xL1SiIl94F5{ntPQ= z--4&%eT!7p&j8hyNmZuh+Ows6>)so)oNuq1#Y|zHLNgZq#5a0)L2R)|;KNarlxtO6 z-5vo1a(+eRsHh?TJ8}<*j0di?Tv^<6Nt|JPnR~*iJzrJE;%@xBbNKXW=8()?umME# z@As&&OE%~5rhByj6`TFLVND7gB@F6`x>FG?Hv!d)cPp{Vepl7gnwSMyr-5QG0BaS6 zuRbiThFNqcJ*ueaYV|LGhjOIv)BQH|wg0r=zB8KzxGGxe*^RrHwUQ+)Q<7=pshDwfQm``O>bnPa!sM}c z-{Rm*DREDt@%A2pALYyw1w6ZvUWX;c(CEMCc* z>Q4uAf9IQX&pc!y{z!XA4^}mm;2BQB3wtS=QjjIhVASzNW;SB>Mh5Y07H)qhSuE}< z4;L!31CrB-fLPQd3DHB}dEb|i7l2aSz^ha@xND2mG8UBF3!=k=mIcpJDk<}Vf0dKi zddaXmDkNJwKWK%tBWz`1j`l96-r0=8-nWM2T7R}AfU+?59jK!Weh z#F~EzFAADcw3lZz1)}?eYTI3{PEYKi#f8A?{z=@9>Yv4PEbp^r9kKX-%f@q3vy)4| zH8w{Tu}Z&(T`R=!OWox;@PKrO%~0BOf7cSR$;Ipha=1J1QgLvDMeoYwdEa}vbzy}j zSrtXhQSr|Q+Omi4(cEcU-eu*cu&`eL?6Z{(!c7rgY{cN45ZPS~Z1>R;KaabqfiVtL zdLH)$p2vvgRNGu|t=fPPP_|JhLO_3q(Mpks){evp0vK%0SC_xIvCP=q=sJwe)Judj z+*=7^wmZvC%3p588lhhqMR`$?&3Uw?&cMG;9HQ2kYYNXT{u=QD*A#GO_g^{U5)EV8 zSXX$o>1_mZAFY}0ow=8s_{mYnlQw_@Jyuf+WXAd>b}G4d9!KhnsSb z@}B%7m!9I4Z<1vgzkZpO1a~1rkXK)#08T#w7&H{l3;VMQ%=k9VW~iqq zy>`ia($UXKD!cZ#_FG#hNsfI%6_S{g{|WP94q-cHr}&)}$Gn3FW$=tR$oQOZv!ZfD zkpP=WK(ubAEDKaOou(NTlYKk{ZJ@?o8O^_o`&|2-PA{-t5{zb?jP;N7z|18f?)xV# zwU#*%ykcb@i)xy$vOl3L#CZ?Vp(h#*zOVDYF8~|%@PP3f-_g38(hL&}vbRL>3HJ^= zyfp;}(~Dm|gg1r5E{c{}^W-^=@Em{e}ke zkyyS1bRz#D(B&AS7_~3(*q|hj?*tS1pY>JMJjM=d(stLc^&sA>@MiI^8*e;)UGL-VPEL8zwO?yqSt8&3L+gF zrwf8Dt&oDL2CObT#S#UEg57o(CGA>=AuxRqnnSw>Z`96Y)YO*}Da@6jg;|~&`p8Qz z1?ul+n_EGztwxmqZ%vuq0-iQoMzQ!}{i23C%8?3?RJ8dT&b%*91(%)W5#`(8qT?s$ zq78dnH=-;7rt!^Y&JJUxvmjTyrFObk4}8UQ@f-%2gN#O( zfcG>G5%FmOa7g1CN`JlGl>h3Kwo`tWJ~LtR=bzL?NK%C3x{gk)cH;4`MddKBH=o)a zT;>UwFAh`ysF&0-9b zO@*AF>+c+x^}`)7x&2v3I@(S^M!b>s(VxJM{%D2`S27`Rq^&bl8)g#+$CQ+KHaLiM zWj-yAA+Azko4@gVJ&pArKPQQ?{#bv^2tvJ)Vo3+#2rn6ke&OeHL8m=UVhhil4v%T?K)m> zBBKV*r7S<_iY1V9gVFWJIP=Nh)}dj#@^ja{4G1N=+z9^u0_at-Lj8ha{^@XTyNkMi zUWwO&3Vgf!cQyH9Q9R7?(9N|ID z=AhSK6zxn=Ei(L-a!D_utv0Fe`L+}>7e2FX9- z?Wk_ohY33W+_b{7rnkg+?^OQSp0VYbku4g=YUCrBc~Y+}oUyNK z3QspVtLzr%=S6WPlMSsGZ;$Qbm^er`oD7;aSpqs&j|>Z+--D+hMFHz=~o$AMOHN!+{$CwVm_{d0!XN* z)cypknwIEW#Veu8G`=xiIg0OZZZ#MI-cH*4s(qL>87xlmb_67MnmcvGx+sP(FK=Raqep~I2CP!8 z&wCya=8eR?%-@nnh#6xpVFF(zlZSayHY-=PF|3K2$IP*3-5a;0B)W2;$Bnn0F=h;NKRSu`jJCZ*0h6Vh zkkJ5sm|+7>X-SVi?J(hKNlgSU3AvZpdVk`e^czpKfkfbCUn(asP&(!2!r07iA&_l- zKJMetnB*Q%#A-v-E@`$MrBWH0Z=H_s=Ftd?#lk{|o)O!%uz7RSB}c`OiV<&;neL=E znyjywDb5g_LvH;%iT@6mVUqogliY1KH2ZZ)FSN2k@e}#d-VPF@;6HK9>p(o9-M3hb z{OMCFyMB_V?c7+!`~nLltzt@7Ur6N0ho&@p$9ec-qA$`#Z7Z||{N)~k@-^YQnJM$= z;8yr`G{L6}?d!t1gLXgsZh+N8_DBDPH5TrYvKXiNB+(-lJk3tUHXQgk4ZQlng~DYD zgt8b7K>O=64npRL+NuDNdBEnD>>&i1Aig^*4uv5$HUAES{x1+J)7r%~ve{-Iv3Kg6 zmm#o|sg(p*zjO20KJnmH#xSgk+_qyjb9PkbT;+-W<~)X`fh4R)o+{#!pzm79a7LF- zwDrkVLBWHgU6Jw@{(kl2w9ZT(ed2c~vY($Cb>9`;jTSzCuc~Y$c;z}pz zLWVkJFZDLhOMEOhw(v9Mgkpez6wK^IfQW?zOE$ zMw%dGF~;$u#XB5e^;laN^cD2yinMm{^WMqk6}Yp8=2#KjxG=LE1>c-!x$Bzo8?Ob+ zAB;Q^9o^xY$5S!eTo4Mf&1|d}1#!`2Y#t5=O2gVZa7misp&2=JKDxit<#PLrEQC7Xp5d}T9@wlu99wFdpND)Z_FLk))3p`0xReZR^CM&wecw-M$= zM^`v2gnTe6!vtfB&RMMpNk&si`I|>0#mW$kXSOGm@vTveQW1$3+g^F{e-+{r6^7(vi>J$<W{8SVMoM zY7sOu+f1S3l^d#%f5_`vW>buzW!F>8z$Y0v&t;{Av$62+jPx5{5$RJwscHA|31PZ{ zgRGIaDpl90u6oW?l{usKCgwGNnCf<)x(V&cuXC`_;?r%U@|`X1p;FAv@k)a=XI$Rh?>79$+P<6hhtVz60;+502 z9ZyEFu(N|q4Jxe7=RCqZ77WPBk%B+oBiFTa&l6>$)FX#-c5JjD(|jjq4VIp<8-Sm= zwk@z6a4~>!o`W^TTxj1EJY92bdv9(uf?s9LoZvKGQ0l?Q-V8c}^#-N*i{j~ZWF+l8VSvwC$ndv|z9Kh+8(P*ixo$7D5#}UjC`55avH5|1 zRr|z!`KKg{4(1spr-*dbxQkYbRAAQ#MX8POR3=7AZ~$YFaf}Y< z>Ro@v_V7H~W~BkL)NH~r+U0j61GvOU8-N_~oDt1<{{XwQum9|X# zjvT;BrYeRWFXED4iTID>d+Uu?#CO+{9Gi*mCS&Yh1M~*Gx4}rVc)w4BaZ=L&NaF)M ztB${Tc9G%xS&0dt=J0FEp2 zuB{(R@6B_8@mGcIHM5g;Qccj!CS`*+@QhdXijRTWl@ z6>fRJ&vJX!nBkHGBWITYs&mf%_B{aZ23n*dVP9Ub={O&n#mjEXzF`sx8X?l zf4k4|ulUvLHpRGpK4ZA#V1JT2RYq-XxrVS;N6OaVd@uNvH~gAjtT4dm2+VRb^lpBJ zzNUuiN!+}WeCM8f`eMAp;`fD@#GW6L<|QI~Ki)=r@z~ZU!ygz;;x7)Zl;{0FP74%( zgO-c#hCT8+AO5|27_Z+`Ro3f9bxA43HhSC_4|?I8jtIc$Pi`x6IFv>M{OW|V=RbR= zKjB!G_RDD|__^oj@7KRRwbj1Mh>_!6!0_In{{UPM(!7~j95|UdN1ykT`Mu87Pe5k%OQ=V8bolk&z-@nfFD z9M_&`KNH^D;qHT|EOAYA(1;mjT&C-F*uj($yK@eQu_mUE#8+C{F0p@bu}qmG%26C; zRDTkt2Lq=S`VL*3ELIYf*HoK7BF}hIu3eepC`(5fw7o9RbiUF29c|$y@OOf4q=U(P zq*9&hC;cxP`L|%=P+HQ zW0Ufadc@ScL2D+ne|H_i%Ggx>+3V!5Y;o7MbY|AqQ1Pwht;`DX*y$@a7;)x2i~&8k z#}&d~%&N25CAz^JO(shKtMZM(fEfG4=CqYtEet4Od8c_U$B*9pGt<5}c*fhq5lFDR zvc(hzGYG#8*RU7st=o>%_3>9y~XfUK6{RELydOE-mC4^>@web&)=J6J@ZMF*%WQswQ%*0_zFy|vA_UbF|PaEl$7g{vBRcu!H&oN5|=pRB_%mR3`65@`%89y8Ak zj&Y5nis5x1g1S|u{MyHXFK#XTsoi0PWMO-0w*%yza8AN@?U3#m;fUh8try}xx8aM3 zG~bNYQ)>ELQ%58kvP8>s6U4!k%Oqe2C`TehEPeXd$=1c=T}+u9}&-Yr?%#|JHFKu zst>sE$V(17g*YDd=^qZiZd)gjbl-}4TWR+yLbcVlUJiK7ia>bB{09Tq)9SyCe-7;a zD)?J5I2_#@)?!oQE67QFa(;yYjL zjb7>@_KO?04Tk6?wvYfMi$BCLSEB*c`-?uMi=vwMYR9jCBlB(~@S`7-*OcS?%sjsM z{{X-~ihqJ07Vz>FM)5cHJ@$#EwY|-?+P%Ef zOSoa>2XkddBRqkQ*e1OnUKZDyd3{bdSlz)x8x)wn?sl?}Mt_Ls0CCSsqvBrk z;wuQ=-q=I72-9xZokz-43<1al;=QU^RQ~{pthTRXb@o<(`zjWuh?kJ#aS?H@5G3I;i>DYa5s zY->_(oP5s__^Yk`r_Wd)%TmSU&l|}-&s_Ge7x0&dHE$4jpG}&|7)6z#H~ULY({8R7 zNTjkmE?5&BrYzvGI6MaD74bjqsjYpR{t>Mr&4Y!F?u!=^F*|UZjyoJ+=Ds6|>OzhU zwY-nn{1(Aa8N?K!Z6T@oui^<~p6c!3QZ$if(iLXk(R4Xj0 zo&gK>$6E8x0;oPDwhVeY^y8~yzc<1^_IjS5=6`8%T@UzH!9i`W{@Q+{EZ$|a$__9Q ze>JNX@oWg)3Bf=8YM}&fw#6H<&*V7I;akCX#y0ifXYjAgo4aPXhii;*9wOZ5IVAg5 zJ@jzgK@@W+WOa2Tu>^Gdd9BuwBE&e(;g9qA*D&gDh4rw$f)ZM7sKsgLy+YO)~qVVoNAPudg1qW4O*)z&i7 zTgirD)D5})Ij+0mE!>x03buwvG7EVf6qEctK>7;$e8x()8WrEfv}XByXG&El{f!)c zchls1G(gDA#Ej%)Kb=^fP?4>`=neq>wN})D5mq>686SYC%&R=cKkp8mffe(y(?fn; zM@4S;4reQr-I6f52vP>% zeg6Q@0;R`OlC4E2%F!02kexPo=3S!%FTQ%3`3&A4haNv&Q4p@5d`h_I7;YQ)gCs}Xa!1tHtCv+#mn629hoOb{6`AUGj{~5U z8+afUBcYAC4OU_EE$$>B{_U~1C$10WUKj9V#jnY!y=||8XK^?PBYac zOk{Ry^j&r;_BHZvguGFuj~8EQm(cvTR;DNf$O+w!sn? z?V@W%l1R*GqdsQi^MW}9aCqoz?HuKKLT^L)?yUtE8KtQg!z-^M)_cN1g2|59vyA+^ z4iC3%``3*4?%d1cZ7)~b`?xM=E&$FEpO63qvoXd6Y@ZHzm%s^sYX^vo))xrZZ6xsm zs-d?eL<8M<+&Z4s#!ac;-#w$=6*m&Obr?AT&Os#LgUI5dgruX&)~A25i=RAYqaJ&&xZ#si1EoU|@Pl}3Rz4xq?WJ8WQU+Om&Y+ks08mL7 z~C>`J*#RDi=HL$m9$pgH_}&D(4#wA_Rc-;5$MKib>(r?yhLNT?N|Im ztbK+#b2jUSRuP-a-QL)v}{&b_bBwV8(YWL0|`#?J!k z77T|y3xEy@1dwq|@W;nZdqOMWe~9{8_Fd z-1e^{z3}Fvr^yU(-nGM9Kb>uH8yM~)le43B4eNu0-!=L%@z2En00nPsZftc3=J0ol z?Y7P|y;|L-g6=jSe%9_EG8aZ1qlYR^0RudIX{zY=zu8ZHYhx2w43TjJ&2b0-XOsZ6 zL=L<5V!uAc(47hL#oovE#|q~$%rI(FO>}qf&w}ysoA6R-ZbEP6syW! z&hV0Y_I*#h{vc|eBh~e2ON8SdUAgae`&Zpai(gY489`i@8JIc5@~1b5KVYC-L2e9h(6LB4bq*X zallzQ;BmXsyeH$EKOB57)Vy(N7_ilRDRN-fY;nM72s3$GzGdARG9WyHrA~YPrIqo< z9^93cnzBEYv)>D|8fn#wyj$PbXMe!dz3|4RaU>Tvb3FF$+gOk`qjex-01ry(<+Spw z9?wY%-csNxY!md)Q(nnyp~G!zE!>H%ZWUclKJa0Xc=a69ExaqGSwEW`MbzYB&U*F5 zeNxTiB%0fy`NPU(7iP8Ua@Lv>MW$Nn7K`SiD#+-6y^Ih(ql(w?<1U+FHjpyw87~g* zzEp>D=iG7+(zdoHlNvz}HqKAW{m-Ry`i;t4W@Tc{leA}?e}!^E%C6^KM5(Kodj6{= zjBOe*3zL8kbNvN;)A0wycJV;kTe~yJyX4w=!8|Y3y*k%NPjp`&Yf{-dHsg6Ev?16tAP}15wU@^9DLaBdy4Dt^!u+heAq)XGL~q#4TF+M z_4n#NmGQZp)+$h^7M-;|%L7Vu6zWuOTdN$+{f*qyTtzZP_SxZNb;($y7{NX8PfUB) z;}7j8;wbO@buEN4GsUGt6e~hj5qOJK)#N3cQM{T`dj9Wm+CMB;#PQvCYH;Z8e^Y%HvVU!f z#N#Bs6q5Pe<|mBDV}2ZwKFWx?{! zGwF}>n)9EAaryo&)4&-Gbr(-&uZzLU{hF&kqBx>zS=JRUiJzuU0ENNp&*xjV%dm~d zjORavVMsSewDJD{*J|2<_qr~4>-tyb^3eA=k@3el70qjax!y8&wsVfS;Qs*i ztD@8vmS{60u2UnpQ(i;x z7U|~j<=vwZ`o;GU;deosex#E4|m{{zuUsd$0lj0EC}x`*BmoR7!?G7;*TTtlR+W+n^uJ)Ui17 z(6Jfaf%HG&URpPlZmy1&$^QU+He+joe;!6^d!1S}MUQUQ1Gn@QjBos)o=ywoj=c^) zrBS+UDg*Ona&!1nYV6~M3(D+sFngzE1x9xdZ)(tBk|=8d^U>;66CJpzUU@ZzieluP7AAjy{uYVF$j<`|cS8UFz5 z)lEuPf;jx6wUasZ!Rd>8o7=^xYC1DF zlqMqX5yJ3rCO}W83lspS-;~{vVOh zxR%#jv$>8vk=w1hNgAAFOysck8CA|Yf^%NgXp;D2#P*u3b8OIc5=o346uILm>$jYN z>_c&}a3d?_BCsa|SYZcJD1WPQ99W61<{>s>gRq`7aQ<6-rD?|!6uj*;VC9`Z=E zjWXVN2NBORVG4B{l~mx5OxKh6slGmWdC~8ph7}*`?4v|MkM@~af&DApHBTApT5MBW zTj}!LNecbkV|E85XO2F##>1=Y+WazH`LkIz(fgHEC^$Q_-=9)`mGU_3f_RULte2xd zK*)H;Iegc$!@^7Z%KreV@xHC6{Cd8-Ni`i#;m8DK+DAJ`>6HKxUVq{*_*(iMsY{(| z<4#g@x;D56cL%C51M#o9?=`JgNVzt#0Xan6PCy?ndX@G1*O7RW;%AEV%~B{WJTrZ* zJgCmm+D93I^T*Ef6-35;N#lWEKZ@}3Ql{K%yY#vG-c#f3VOlYs0t!8Cx$#Qsemt7w z$^QTeRpQEoA2FnD-o!IF$K_p)o$*8BhL%F<{xH?!BcGCFkq`U^RAK&l*HPjv5B7lZ zgx5FT7w`mnZJgh{#m1;^ijMe5M0n3!Wc_RAO-OuFhVkw0pwr$!cK-mby9xQLIUr-x z>tCPZ@(fi8xXPqr{eR#e(RnW(S+Yi&6P21vq*e50H) zI=9Mt9+mK2-2VU-EP#q#FHX4`>4B(=V=he_2QQSz<^$77G(PQ*4d)nqUJ_!u?MJPj)GvpxD4+WBMT zX-b>g`X~PY1p3cS@JGX+i+F37x3a&~R%nuK7yc#pjOXSNO>Hi1<|m?%@s>X>cVj;? zc>e(4zr=5ZdX}AkrrkEHplhsT({H@Dg?`ZhK4rb#y~Yd|DlzisI2lG^$l;#%#or6{ zue01;$_OEq{$=xFCmEJ3@&`MLf_x@GtFSrVTex@VCUeco)fc`Pr{7cmQJ)sG1G<*GC z#Av#u(P4>Z5;S&F+?B`7$n6Vxpf(j;dRNB!KA&X`?A{=X8+~U)npq)u?&U_AB}~F3 z*|;;Yj3M(7Hq+E#;P;*i*ECNDUESX3miC&Jw6;;(&12@slib~GWow&sF|H5#r}C5m z9Fd1YKJ9wgyfq5cJ}-FrDm5{5v5uT+{_Slm-(9x*kKE6LzBavY?T-z3`&3)4MXusq zIe=LATgIZ)?NH5)vqb9al0#(Vf(?58<gBx#u(9At1kv6}o>@E`4Qr}$FFFAe-q z@W^Y8HrzF(-Jol2L8r-)B$8FVltv}56TZ_3Pw-Vk- zu&*a40DGL*fOyZxq#3QOn|k2oi2gu-lj&TC?M36AQ{g4|g!O%C8souQ)3v?j+&h`A zWO10~8+c_H`IPgHMK7hELy8Omn>=LBb- zc(2v6%=-r@%A$9+r{b9I2h61^DaT5iKQ+<$=yUqkw?3tKG=#iJuCB>V^SDFL0Yc!g z2iFz#2g0w1U+{(5OCO3YzSDnpzq^_vxe*8h9-(pS2tDgd;itjx3+VPsa3M>p!WL&~ zl_fF<&mw`%hhHK&o=DzdYWf6)2I_N?*5ejWH%tIuf+US#l? z5!ig_^C?nS+zi*@_K9O9-N1!8FO9hL9e-N=2K~BxTXZe-F9k>Yr=5+=>ztC^0Q@WB zy#m3bjNK^1D(zpO&PU^4jd7M^&xw4yEf4fJz#NHSG6+?d#ZmKp`+f&ET{imM^>azN=W&0_AI$rOoA+ICeQTh#Va$wh6-m#q{{Zz@ zJmHPBYyI*CT}h@PD=X@l-uk0VzWT6^A#YE ze$>fh^2l;`7X3;~~C{)pN{X6ZqD0-o#ac zT9@tPV;L+qk%lAMuSKyxct_kP@--!-3Ph4OImce~jH%`MWbw&AO3F*2=SrtDWnD_% z9Y)>lr(Mf1$Kl$(Nbn0w;ZKP-dL+ZjSsqB#9tP5KzlKHyeT6%3hjR1-1M%X%Tll+W z{{RU80E@KG7Dh0yBCBJ*+#J`tlFynGqWYp$lTv*@CVf@CS)!LcLslN7`_M=RcnSy9 zbNy-7w=vymcJsvHmPIV2bRdj_Ofelods`4TnF$+#;Af1ScILS-lzFPg9%Nz~rAl=l zME?LI|Izu@(hs&l3n}H(AByz+>l;=xXxElHn|gNuz~DyE7ml(#JhHQu!o|nRGmNqP zJDUEp;Y`Lj%oHm(s?qwN<(G-vJy$8tYhatSZrb#F9`E4oF2lrHllXjmk%*WXHslGL z8%BF_Kh7)Ev|kN)gToiFZG2c(+E>Z*4TsHW$6TUFy5M)d|pG zjPu4g9cf>YTyUo;y$x^e%S^~G@8fSTk0pNaY@UQog_N z&7O~^#1l-tk*6~tVC@aOrIc_wusP2-7|nV3tV~zBw>_*LT_tHq^w)L55CpZjldNUIJ0u6?a54(ySI9pXynW!G79C4g z(Dj$_zlp6GZFLU}>M;vFM&5S7E`Sh|DRa!qS#i!sO8a)_#~upsRHwvVG}j>0t?f4r zlDc`Mw@)oUibKkPqxG-JZ`v!xns>)f9M9sdPfty=zmsJS!{%Ds#DvGWf$Q?qqdG@v=Q8Lf= zb8&Mj#IxNn`P(jY<*3OS?SgUNjDHb$m}yg8OLb)>l(RO=Nu&EzQa*Zl5@s=+jlU=? zJ+WN&v*8nJ43Kz{k{57R8@UXR!2>x`-EohZGt(s3b7kP)3+vj1cHSh^9L?mrnBkF{ zNtsmONZ({*3iQhaY$!P7Jn>Uh-?;MayNrm>Qz(?A801g52j~aM>2(RXX>OyWUhE`Z5PbOt6 zki+I-gOEWEe+u<0-wymQ@Rib=t2+qf+$0Y*-OTC$7{LDkR_86rI|1|qzHXtU==c5| zz1KVwr)heMi`Am7$fG07;E)FG$C~FN@TJB5`zGbJ zg?{thGOl*BV~HgKePPM?3ho{!3#NYPReld$`(B$&HdS9xzmlFji5} z;MPZqp_+DmFG#VL-pVlS(@htWvOFujk`>Dy00oJ|9zIkV%2?UA%JfFD;i@#+Z<=ye z>1h1f()css$AvsqZ{$O(ne{7hLs{F{O7c#TjL9@p11xN+2Rm`MrrPOkJP{s`;|mW9 zXx1}ZYC65TOKWZBBTFT-10qgChGj0fY`Vqr=K~e&9|ycYHkqPn`f9J(?llW5-5TOt z1(V9ZxVCg4_5T1@D`5I@UpQPt;y;QX8a3Y#X#3<%R`ztY@I4(n;R#_FnGaGu&eMG4YoE^5)CJejK}s?gWZy{FA=wG;#8s zlRN~611b(jQaGwNx<8D(Eod}tTSK_Ex6|fFmOK49b}Zbg?w;IC$}_kWW&ro?U#R{D z&@{h=-w(9?8%w!+>-*TDzrVU^GV@%WtT)Pj_QeXIb^wklo{K)Kb*m-)t(3Q6yyCwq zsdq834l|AWT&V<+&~wFo1s)EoQw{BETJLLlpN3;RWvztA&V@C2MYVV3`D%P2tb9@U zgKgnk{{RQ-dKR7H4-M;f@Hg3Q8cFS<5ex|;Qv2=hGJb3*9>8Xj~n-eMdt*$nm%7BtRkIcQZ`aK82zX$l6M*hdwyg6qr(YGpOx`jdW z3NpmaAj>d|Ameu|JuzNE@h|o+_&WN2r>JPg?m2C3LI4^jdy^PnmPT|Wh9f-ZZ$NR1 z;H|^;u<)Ng$#mTG7m1mEW64UjK1SZXQ+@vc;GUK6qvC&nw0%2D@RpUVw04&7BwB2@ zvZd5sMn++d?mQPo;HY&hx%sQQxqP!szIV69=jMH}riPN$0h7$&eBJ*5 z8q3r#FZAa!LIkmr2@m`uz71BhyR);hO-8|s!8go$o_caWO5y%6{6)6#XTzOm#9LHJ z9kVPzo=mPbt_QI>uh8=v-o~7&J*<8&!#Qm6*vdF+Ygsgp#~<1&#Y5r;$BkzB8_c$_ zV+361?s3QCSXy<8!(|L)bF{JT#dH1}vX@c5y3}s+*B8>6Hy-LvPwQTbCzdzHgF7&* zkM?=5=FH0z?JGCZ=lYR?!^aDTrG%V6^eCnE= z*HV_Kp#K2A`L8bct#&UwSu`V+w+f@%BXRz9?_aaUlEtR#_YA*%ppPTjNk7b2(PQ7U z%ei}>pW&OSnqn(-R$rO)tgKMLrJ z>~JxUt$Z3jh^=?kzGA>(RO1-puy4W%U5^+b0o&6x(9A@b2aL8`=qr=dCoIj^j(G1{ z9oR^=%%=yb`9|TI@DGXm?L1LosE!IWFYl1V{{S&xL!@QZQ`C&tfP7$#L#e>>e59;+ z)|6U3-g}WdqvrvX0qKG`r$)ppNP4gU4z+`(Ol~x*8IMyGXYx^+ z>ETb^tDGF4^NRCkttO4@E>u{C5xykqa!DSwt&Nio!x;Yn>(y&Wi@QtwC{!A`bCiAU z#!pJkr+cH!t2@fZowUVLM9IqI>q#mfBr2Xm4E;Uot*mU*Jd$!9asc%mb6b(bjSC&T zfrDApT}}#(Mnnh$K+1!5TN(DRBlz2*E~DX_h~r$%Y8F+;sTuy2?RIY(z&>0B$v&B` zE5)&kxUOI%A2uMo_P{*Xep^0Dv6q>hJI%G^d4IyKa!q5xw$|;P)>(|4{ww_P_*c-s z4Rn{*e0!u>6%1NHIq8HU&*-)BkHUM&to%o;XaI<^+t40>ZqH9(Ywf>-Qf~3to(AUL z*5QX=mob>~J@+uheO_0W^X9Op(X`K=)8US=C7KwE044bk z``y2#eKo5@TTWF&`|E{NkB{QVC-72F;a>xMKGuAz(H8Bw#twQB(!TrAZT5UaRI4`yBnBLsSkSLUCM^oXx)<%O6s$Or&+ zB=MYj4wdyk?1|&W*E~CO;d|K?b$t{pGRAl^q+=0GJxeFZ{^~tz^p6bl$4a!Y)0UF_ z)$RG8%%4d<3|QO^EZU53Dpykf01LLiBk65#Pti3;Snk!Lnl4d^WF!NQqpfgy_u2IC z3F^`KYH_Gvc`{235y`!r?IeW_k}JRQCZVBOJaTI{DQMg>vywV=`gP*Ga{l_l%KrdK z@ot%Lvcq>ftICHTxtS0mmBGP3yur^u%l6D>CDVeo?_>DWDZ)mi?=_;-uke1>%T(~x zT1KGBEH}3865b~dyUS6X%yKr9gZ|Jp^OwW8uQVTsad>xKk(T#Bid%W3R4Dj{5?{UL z&9m5R+7wB16w!jdd|^&vZa!pvzjvyUp4hJw1MOOrX78!>nUkXirA|AeE5es!QTV^( z866&50TM8UiNpD^gmA!|7C7(QHMt&yE+NzOyT#dOVzY~A-F7Oh-3JFJZy@uE@_&Z+ z8l}DNx8^e&#evzKvOq?IARWY#R1?9j`dx0qI}ZRS@mT9k!J zNeefX93_k#XW+-Z_=n>dQM|L^@rK>1 zD?*FU-zxaW1v^z?aC64KctzQ5cc=Ul;&W~(!Q}q{xSeRZy&8)Ctb9wRufv^o;`Ovd z*7Zqe+|O*5@Y_%2wjM-A-rJoHSs74`zbh|#-|$uUfV@{@b>UfVua-dJcHc!3JWkmkB&^sg#lPF);aR3m$$|1bUkF>Tva0!L?2Pr-M_) z47QzLXZ5FRbWYxk@%6FLVT(e$(qxY3ZN{8#e74-BZPpJpf&S|xOjP#=rG8&oU+cdL zz9P?IsKG6?`Zd$VJSCbpTru18DaiRqDo1h+eu{YO;m?cw2Xz(ih2}c$n{Lj}_I6jf zQO@@YND?;JJJhHT%Z;vEJ35|^;h)+A!8g7UwY0N?Q`N7mZZ!R3NPu!6ltUy39IS#l z0C3!{0r{1|9~C@3Ounn5h+gcvpJ$5CY34L2<{5oXZcQY-pZqgEo$xn_Y(69Cz7+8s zB+7N0Hc3Wuje8Pq^KdxdEO}x&Z&vlMq_lqxY0+6l4C3O}c)>Bq8Ji~^3X#zF0~Ptp z@HbYy@E3{vaqw#L(%{44ooUXAaVoeHJ-KIC)yU+@Y#6UUFeA1r^&i8U+TG}uTHS=k z;>PiJ$Gfh~R{( z_&a5#`1e-vPMD)k()EC{y{vyKrP2nCn{OO4;DS5n+P!)W4tpD4vRpDqp@U!&2tKvF zr@g(fk4%d3t7Q0JXsXkXytO`;F3<6lsZ^oO?#)@QmMdA=L#5kEVK_f$ zkdxftp5XrgO8oTwwft4&Po(@e(BWyvGr^mdwpy4Z&uW_{Vzzo*EMO@ z9Y0Tr=bfMKszx$T_*db7h`dv%d{XiDx8v)zY-)45T1G~Et7Q3OUVRq>>t74U*{orQ zRPXOI`Wxu&!p^Qfrao)jq_^{AIwg;jZyb>*%xm%=@vBoJi&G}=n~*^swY>$Hvxmwc z6o>;#wGjtIR~gy`k(%_aMvtaLR9n6e~oo| zq>m)69zJZ~XOFFM?2OlVZruRsfm=Bq&I&7*=7qYD(1Xrc^!BfvzB#iduWSzkW<7b& z_*c>P*jeLO`>~9l#=dX(;KE&Q&4I>KIQp{>@UL5k-|w{}7T+tkm*#p`gKrl90K-;N zj&OxD{^`K|1$sTW4G0H<2Tw}jyd9?-Uk+*U4y_jQPy2atJ-XMR#;CD!0pR}t`s>fd zTiQz9&a6bXPjc0XNNvkEL-P+)_*Lw0mN}VtQ&|wPIN!pjAbQsPB^Eu>9D~jUW_h*r zcPy{W#iAJ@c+YIrpt2+n8#gWKRyN0N0V4sOcpd$!Bu&$KlJz5ieY@1i^W5%bMw6f^ zyD5|US3Rq{I!gTX1331su`i*5Nn?I;#~z0wxvS_}P~aToe!lgkDcVV$lqC7JK0~m+ z{=@j21p9O6u|uBwvx@yb{h72>xz~I{t)HDBjvHVxz;S$zezyM2Z5EaAyy_B0%=(6+u8bogokR)9CxW|_3jnHdu+mmNUooe z_{WX8tZ@80iKgE2x8JG%)BKmyq?b(9iW9V>GM{ay{QgzeQm4hqWv3eQ=;>pgmA!*QCx?Nbl7z}7lPn_tXy>9H$2zL zVX+dWHBoMlc6bVSigUu&SB#TP_YaJJ5g%E+)3l8`SY|rVhBGEf{lVKOnd$@Q<@PnV z@atBBJM9a?caw?q<(~Xq3xY!IgvA^lX53(|rQuJ%1oS+{5|yg?G$Tv^*Oxp`$!Cyp_KK*{fdI34(|LM;vaS2u!uJE}_Z>v8D2 z=9J`SNH(l(A;{0ldFP$His(F1q-q++g%;n-Xmvd#= zht{$5Z-=^fhcscQ>Q=E&c_3jk$%os&mQ+2r6PIzz9P^GV!{S<4oKO1(8Qb}vWzipR z;r3;L%A3w{%bBNWN2`Bn{IvO>D)?XFjsF0RZ{pB&%SM1I8U}b>` z8iU9n1A^7&{v*>S&=*;n((=mU%GKH_u91wOr#n8**&B=UPeL-Mf`=b${AuxG_$R?B zrcW=It7~yQHn7AzxZ|*Z192%-IaNr@BI6lmCpoXp{ZjVkTYI|;i=@=-ttQ`V1V9Cr z>QTI|K_Q}#1duocvHQ3O^GdlbEEM@vxumy!FXVq!@J|!tv$}5;R-Yv%{n+)lR?bt# zy8Je+W2;>0ix#u1BhL-8fFjfERq+y{akQ}+$r%G_9XXcML|r#XvDWNhj@ssXPclXT zWyGr6y8PJ(pZE?doV;7x`SoVi<`-AjR}mx17l9fnB@lCj1dI;7``1ysSMg1qw}-TO zfYdG8*2Ew`Ia!M;5C%_01L||!RMfM^g0+=yE@L%*2~Q1?e#r!;lQJ>z1W|S_|wM~ zGHe|@78TlazN@#Fp1+BIQt%hTeL*3MSMZ*hewMlNh25-ksuPTmBn`>H$?8vDY1iH* zx6rNQu+Z#bwSjn4w~1p#iU)buLP1wCvZf_cPRQk>hjlF{)XMNj!%q#pgfrYDUEV};%Hgs|KY6ztk^XUBUGa1FXNJem z@t49V4W-nslIl8CBq~no2>VT-Z`X%Rd_GGki^56HZ-G^xqX}vYE8a zMrD#aFFeg3+Dobe#%Q36$q_KfR@;o=x6}Us1->ELc!x)mRF}@uv>E0W%{}x#XOi;a zGm&j>PT(bMw!xA(B;z1x{9X7eJZvV_ybG!S0Kz%1O8#uvjU=?Zd|(-3b!89fAQ|<~ zQQ&$$iSc*BP!#y<;Rv<=01jI$kgltzq<2$TBV_si0AvM@z;IZ^s>7~$ugvio7B>S? zRHnJD*R7A=W5k(GcZ77glrOv<_wN__AA9L~m5t4~y@66od5QAJLdrTEdJkX9wd0cA z2$D2qJ$_c{UoChW!hRsrv`Bnc;SE|{Vk=i7`%abGSngmSa^lif%lzr{1!7NN-K**? zD(gtpbjwX%2E-SUtccC%-Hr+5bg#V0b9ITNr6p;3AByo;41GegRHw}Z?dG4EtZ!{6 zP`4X_BOANX6lt7AKH>h*!K$-b+B|2;nL!?n{VRg;*Nk+phQ1QjJZ0iJM0Q$aMZnMc z*E}R@JF^}DuR|4DG^shuq2y%Qb$nhX7-~xLld?Wp{kT3UNol3&-vxXpzX zd5+mn%7^{q$@U)g@y~`dsH|;+pu!-+j{I?&$+grqpB;FURq^kMShlIINMtI1<%~rB z?EpOh73dHM;Eha}3Ya8%5{p2Ooz@%ZI3YOhWS1^|N~JjuNcAzca@4rQ0e3bLsr6^ta)qhuM4&rNVk73QyGY z{cH1QMuDc9B~i=Bqw_hh)eQ#NTIhDRs4=!RPCWqs0P9z$#dU4UyWH`zNH}0%yRp{R z>P(@A0MF~iSD(&>M49A|>zcm|f=Hw*(T;P)X6o{V5yp5JAd2|-=z6s7sya=az4!Zez@mox2}QRxw~Ab{$Sn(=}Jp=h0AhRxDVty1AA@ennuQdg8u$ z_{xL(R@q0)#PswT82xi!Ls`bqz?kHYex&nXJp5b_Cba-;eaQMBR%2eaN&H)mQM+r< z_iqbEKe6n$jv5H_^w=v>c|n-Orvn({t|^*TtJ~?idP#yji28rHD(YJaE}ikv0Diq| zma6xg^CDA??#PNyD}L-A02%hKipt*U!p0Dvm#!-1hM2}k!wt+x`8>dH(>7ygio5(y3iJE{jw1!{T&uUtUM1pxroP%DDN9F$00_c=f#j~ULx0SF1Hag ztV*%%lOTMU$pCd9&o%dd#C<%zf#I`e=1A?5OC~PmiSmM!b|)m3Q`f&*{eyv|OMZ5;gQPdH#YW6=KqBkf-nUU+8aJIN3x$>AU}9x}ZH z_2&nU1}pJ=mb7cpbR>VEIi?z}9}x_771qr9Z2O7*>|;Ko3VB2- zSnLGpRB&rU>*}>y*qS=W^*mR^*SepBJYlEn+E51SCT+-iOAgW<7!In#f<5c({{VyE z*;Dr9iPO)nwI)i#}(dXYfscr0{J^3esyHu_R zu*H7wEJf0i>VKc^mn7V6vB2GUPSV=b`$8y;zx;sbImf_;p2i|r@9eCZr=hK5<5dP8{(%$PA zo*s;uJT>8o6x{*LS9+ep(M0_6kf|Go_m~dcc$wB@u(TYP#Vrx`{0G9b&N1#~qsv9?=iveJtyArqAjKI&{zU4ZK&AmoP6kej=`FJH5} zn$T(5b*GyIHmpH(S)pi^oOBLL0^DRA)>gLn`pwK1)-15v*+Uq+*f#H)V$yuWspOG^ z&;?%AFNrSS#G04dAvsIdX=EhhYcW1xC)74;^GcFd=YQ9k{q2zDp3a(~70Rt|@?Ro0 zL`%Q5O)9|^+ih~^0RcEiB=9g#B=$9S9}Zb)9vmJmTeY>n)O8oPwH|J6A%+mLG`U}x z z_OG$p`FuiATWFJU!Pr301EqZKDz%fot9$o8ua!=G_O-e{O@Bk~U)fK=H~LiCdAYC= zSn4G;W|~qKYl!VhTVSX%Rxdc0EZE*az{e-_Hho&&R@yS-IN*A9;=XJ6OX1<+yIprw zztn!z7VT_fxIgO57HF}m#xih$vw%Myb6&p`?JCiv&ZMPT6#y_Un6#F_#AmQtPz~x6V3;G4*vjC(y{M8$K|-1;dmLsa!v;% zn&&0Bjy*-J1;Q(pcEDhvf|1ak2_%3Na(fErujSNrJrh!cN?2Ow%8?WX-m!ScRwzTE4A%3N6$YO{8Ods9wf5TR_;k{tpUK=e72Af&IlcLqV>iA&QEIn z8}L4`vv@yByorp8AVMD`2EfKZ^fmc0t$1Hn(Qf0s@iZ@Wcd09)!3UVa81fG1kw8^a zz<1;idivAhSB~y&bV$50cc{lamRo$pV}giOkO&|U4{Y_vy>Qfor)1IX;vG0aI6aT9 z^=}nJvucb>Api_yH)@{N$?l?7zL-Uxb_4v)dG?KMWhStYlf*B-fLZQMdG3RLLxjf);oSbu3lE&}I z@*J!%4so;$9OUC3q}Gz@b4r_{kfUSpHC}x;P)Ldr&c2zzt|+)iNV^@D%qmoHJg1;ocXm5-1d~x`IJR#wki+Df7(&b1WE#<^~G|lR{;Rj4} z-o0P;v;CqT($;^2e-5Ve^-JJl)NZ0V5X64;NJsHEA&=C0*UG*L(PGi8MXW>jfPC(H zk<=6HJ9?V@d&CYWQeRi1?z*4a-UWDO@Dx9_@v*ezy~WvUudidcw$tObh(v%f2PKbO z`+9m(Y7w(25V6W~Lma6Cw>~O=fCx`9Q}WGC&0VewFy`?0-U1=9HDr zUslzjiq1xlq-aZy`Ruu`gM448HTJtKhpt%QSJIynJW85Hw9s2Pl1W$QEB8YT<3ES; zuaQ;$*EyMvNy+@r_*dU>#t)JXt3F?j@yZnG;bFX;+28m!A2V3f<0m`kPsfle^!DC1 z7KEozqz>Jy^H1UZtKImoNmSr9+$cZqteX8bom$@3I3wrf=j-cUClu>eCv_I%hNTNx z>-reqDvv2iB#;l&{EErd&zma72?0h)HKBVp3MzC}C$Cz?xZcOEO8`H_SIwoN=;7h2 zY|CPXJ%@nVKS5dZ!5S{el$HC(p4?zomBc8R&)pd~s_zcn$TPcw$K3J<;ZE9E^r_Cp zRgfqHBOv1)IVTn1-xZKIitViweA^*G`0oDz8u}6#R!hZ?`-3Nrr>%VX;`IA>#Jf9O zl77(&pFmWuc>KkCSv-B_`y-}{PFf#GY(!;1Fe3qY^cAaNXvn5k`AfD*J%FruBWY&d z+?G5J+*a(Taz_bb6RRIn{u!@2r0(v|F1x?FosEyR2_rDuorph=zrH=|8s_>qw_71H zIXJ-Tey93WBH~MemUi2iecUL^J06Mv=kl*(@K3_{ZvOz&d`pR{2?$3F0F;cB$7^2JBXwN^x!N<*P8V| z_(D((*D`(>?_N9c14g#fekS}l)FQO=-DkYFlO+7fBF6YQ^eK^Cc)D<$p;jwczt2On z1u4hcQw!1O;}pPhL>io7dlc_Ew)vq8ISA==}=%6&&#-LlnI zR7n9PvCe*-IjYxsn7a98Y`SsNujA?~`NE$xCCvly@p^$VDEzYk9962?G`NpM0Kq`)o`Tq^GSpx~c>*8czr z_=o-y9VR>IWH$%XIQ=vDx#Fvh55f`nvsQTGUk^05 z5aee!rZWw{AMCTU_2X`FUx@bl=8>-W((Ze?eCcC`TY(|TCgXNUZoNYgJ@9>M_?Dxc zbxPVq`o9EnsQpe@m!q4vuJ>Or)S`(djcIFbWX&^OK$1KX_G0Q3T@AV{itFz0c zC~I9>=1Xa$mOm+q?u^1o-{t@dZXYfP>))FB+*IwN=zmFJ*DWV2>h$#UJ546f!&crA z)x1ZnYBus}S2l8sXa;7J&5_n61Rxmw?tG#!r?$r0^sq`RU`1@O_U3haFZ)?$0c%m zbnRc%7#Kp99u(8ENgw52X^NeEWlHi_a&7(W`MQ6Jz8ksJ=C`ubE_E$NEw3C={LBXJ zo8&4mquV(3IIXRBPfL#u-Rk}wy))iOvAxV_zN|CW5{wKJFs*2S05=EImf+ybe#Y zA5Pe5x=o}?Zl-6Mff&X@n%9c@%E`mRjLy9{1$?IQ0X|rkWHVbX?`jCA+tIoti+P8DIgq!zvHEp$9$zOabQ$Lk_pZivR(=&W9 z(2s&VGccdUn#wQ&GoP};!v;n@iR?P}^se9biv6NAUxEG+WVKbB#QKu#)9pqWg4}to zI)qcxJx?70ug6U;U1P->{r8FdS#bBdrPRJ<%#3rKl0vVdiu|XIIFb}#=+fN&u<$Fw zd1ETaGsiF8t2Cci+~|BAqcjFxYg3TiUR;)GBy;mKo}=hHSFY)>KHoGBINj>l>5rvx z`e2Gl+n`<9QP3{~t#y)J+FDy1tILIg-abn+U}N#G!0XC&XLq|lv++@~NiZSexlAM0O5`pk73Pybg^`> z^!X1095so|u^(K-zEp^Q2P|W1rgK+zrr4n4 zXv>q+rBkvtNu-k?vW&z9*~gemW7KCkubZu-68u$M<%Cj7<2;aX*!^)|NL)IsZO#g= z{{YBm74wgQ1M0p!)bHGqB3BvrBo04X^|IvEI+F4_aJ4OW-1;WQW9BL+AaYNwY^;*a zxg%dO+=UxKCzF5&i9_%9GR!w-?*CyuSU*>`5QgM1|piyGZc7?V+B^SR_kJI5ct zXMU%k<0ShEY>wXpgOX2939K|CD`0Q{L4n(kN?^T?INey`uy8B-_aew>;AlpL6=b)4 z&+_+-_{SHV<7bS;%I)mBCD|IUG6pP0?2fs`No}S*=>fqplh^$J09vD`=~q{$?KdQ> zCj~*^p4}^~xw*8{ZMMi&HjYMd&3iJPouYh z*j(HoU^*U6e8H&vbMSlJ!=l=2cEaZ7Z?ndsvRYC|+0%oNbDH9>ekOPyPrQ~bYs9ut zT*b>HPP^4}{7MNp{40_;dQV!6@4aKZSWug8Xst>&5qx*?4!vHdlAj{lwk1+Z>-PHa8!p zcGpA10rf8*BF7-4&|JM00OSn3PkK166%bo$YX!FX* zy>dOss%dj8Zu34?Cm`3o`0w_8@!yAhQ>|+rAGZ5ujdG#(AloQy*}w-GAx?A1I6W{c z#4q&A=eS7cvziHBLlEB)jI@fmE9g(q*W(!Mnxz@aHrd$!07bZ4j&K=;2v(<6d&xUr zxda-`jntpnb6kNq1wt??U;W&HyYS6t>beYfc8K#ZjySQqKXsIhVEg)e);^>Si8k84 zopC+0eBNY9zhMXOf~R_w>KG5kz01H8!>Q?3aQs<@OTPo_GMig36~v-Ou$4i?T86`k z6CCBX%DfQ7e6-<|xl{I#c5Bn~Idjf8h6cZ}uO4X2`ESg){m8x2EfwSQ4gi&RZCPVd zL+xRXpd1m94R}teq(ZWonLM)*1z#Kx4$?lq(z`I3hdg;IZhZc2kw#Pc<_cOjxApTq zUs2bjv+;hPuSantQ0fb9bXq*O&I0mRqwOG^d)ME8v**V67JZ2;Gu_;5`yIS-M+-?S z%Ih3)u?KG4y0+}ED1K51{J_4FSv)tVOy`>>mei5M0iDQm(-=7X>!Z-TX+Dc?*1`zy zqLpFXvgMK{Rb>TNAgicvm4O6jgI;v75=lBv(vIIEGX)G~IbksgH6*ltXXyU`?c?!w zA>pk9z}hsPRQifTs7}lBkQ@-IM^IM>IXoUK^6x^9WwV;N*}^%cqKLu_(x2Xro7ebfV=*QeCeyf*$KT}Ja)({ARo zdjQiJBRD9)44n4)h#vLl<6N9&t*(9T7;;XO61<(=x^2J6={#Ab!Ke7|#8Acx+v)d@ zZh)=}7>G@Pe|VA8wSBMfBg5Lf+HZ&TYn!KrXtfyQw6u&Id1W1@mCg=dl~wGyI2@Yz z7f5^EO6_m1=6UX}W@#jnRxC-8w>y?^Qb}Xqt$o|zUl(fnM~FNHd!{Nch3xffYgw+P z&dZyI8{J0LBn2CG@yh}AuPU6Jaa4J9w3Xl7aB+?rrCgS@I?6KBzK>6t`hjb&D9xqJ z(p*NsaUuhb++>=D*G$u;l1Poo#GvdULX|$8WAGJn>AW$hm6qJJMnD*{AC-aVd+#6=)INohbriU>Gg>|LeM^#tmE7yi?%~63$Ei01@6pr9guv=aFI`hU3ZlSIYh+{iVJN+f6JQ zJ;m;^D*pf#tY09<`){;k-n=|-7GSW?_w_9NwfoPs$h_( z{i4`CvtG8EbShbiB~S3~BntF0?9v#De$tw1FTdz`Ip+`6z*l&B&Mr%SS9^JSl~&Hd zPE0su`=^tS@Tla|Y^5a2ZnAgz{$W~zG>`7(MmtlsD}%fh3OOX>kEyP?)=^GUdLC6g zJDikauX810f;LdVq+pMcFf;!E)~_D;-TP8_PvC}uB1IUw*XB|!Z1^l&AAS80erCM$ z_K5wcJQwhTNt;g6B^sBACquG0&g6(5H@gh*FnAoFZngO1toY+n@gBc<;%^t+8=X$^ zT)LbQ7&e%(e=H5 z#h(#8S9{|R7hN^xt*GzayzvQA8Bqs7HuT3BuCi@gMbK6Yn~S7Gk#Q(fmdF_x9;2mv zyL;nZN=6@KZ!3VLgU&$4c=k2VJlA)vy6Q%3cFq9Jera1IooRE{m-(O8QR93z9t#hG zhc&cakD>M7jTSac@aRzQV}c8MkMrEuiEG|E@gIq1FMo3Ggz*?ZDE7dl()=%ftGHWe zi!b{l1D{qk?cN#qNe#QD#;!8JWFYDIj;Ha(Zy4b)i$!*F{ZBW{-Ret{9!H1i9u?NL z$w63~X~!plUf1FO0EG}h%OxAOs_KIp7RrRnN3Y>K&u#a=AV6(-nl4wm2%z??X!Bcukpe2ZH( z5kfPJ0)NK2ZD&#PiQUw8&lUPaTb76O^wL_hS5w#R>=Vm}_mU2n>}$&POlWq;m-`h>)Cd&*?cr)RKf&HDOTSskd7x&XihnnT_%gV>*c5eCl z0gfy4Tf$nduWkEX>bi%98rnOhlTldS^8I(!WZ4VeudA`gN?nHPx+j$)rftmwv_GN6c}ONzQtH z74m27!>m4fzY*heFbu5fS|@>kb5I6a8SK6|2g_rY4*LE%4*nrvPc*YXlS?I_Uc zx6%#-mRD>HM4rA`Wsy%9$2Fy=OqR>%YmV0O78o0MV3Uj-fA#Cr&Y|I*TT6X5^jT_p ze2SsqxDiVeXMwpSC4QL|_E?-eQhbWnKOn(ksyQUy+jl&J;s@;K@TXGIuI{d_T zJ5Rd3n^ltLAGERk+U=2`f;Li2%s_qX5g-s(EKdf%9^#x%9XBdaS6x?A`?JDsAIz!X zqOrAHxveD`Ys#0d&D`ps@g}w4jWk(n8g0gtsh=)*Cf>?GXxqw>SV@jkDbS6ip1ou7 z7lgFEb4rg;(OMLgmSX}-xIX;6WO_JoK-Eco}jk z(9!;9?HPVLFt02$_1jaNk!L!7p{L4@j*5@9fd|Y(wX!{M!zbFgT|Vuu8CUN}&pvHM-F!SYG-9_mn$$LG(| zy^Okk(wpX1eUF~vxXTNQrz_qqJ%1xk?pHgNV;cm>o6l!Eh5+1(N5sTkr!&IuU952?=| zg?e&autyIL;w3y}8)wDJ`mRCv$AxPQco%p z?mu>X)OTjbE%L4hPPz81E6WGF4%Vz^vXA$^Xy9$f0l&I;5D4sZ+nU_*CW$?tg7oJ= zcDrnL?YxlKAMg{L``3ewlzF1Nv-H?O)s;!?lx?SWVd!@k`pLA@rdU!aLZA`Ck+Yvy zWdWPdh9}xx9dWRdIL3MF^0$q@ zZ9j;fA&zT5hjy!=X(KE4%e+Z&M^BYFjS2L_5$j(o&7l7P!bhX%Q`_D|F6^|EdePjl zSduxXmv&^y+T#F)Y-BOybgdl&!3+uaI$w*tYj8FH01;kEa<9q0)u-7WJy1Ez z4`f_d*T1um!=HlM=ZIuoM^PRp)hu8aBHd$X?IYUYWtD(0f<`iV^sk;<;fA#&kUqbs z+-rJ;#C~|UTi_%RE^{G5nF+zc&uaU3_D&uP(zHJj+&zV_hL$-YStgoREb6)WU8F=g z40r$#bJsQVc@1h3%qhG?{nYO7v3@J#>nx76Fc))b%a={`^*+1v;3zzR6&HX900HPd zDL&C0K+7>zjYdnc0YLhi`N!gC?JMA42V6dv;mH30weQsI0T(UiH$(}Y*(3r`N7Qv+)k1=ILFJ_GOHvRZ#R<=1gtlf{V%Tiv5=r;uRS`WtYR9_u44_OyU0k z12MHAv3a#sMw{=fpUC||@t?==CR^y z>92Jep5p3uEX}y*o})c5bIT#lWeiXilsVZpsi@_Q3sgk868jfRoP_-GOA0k$lcrM zDyg@7pPp04Uuy6w)o*j@6-L&hk)v{aytdQV_-bv44jDIh=b-#MnwkqwJ0V+SYC87) zYRh?14X||`Tl_1P-?@yct(K)?07JpS>)SttH6fPZY(&_fPEBbbf-oN8f}igCeSPV& zYEnt%!wP_|asAQjn$ArlH&R=o6ooB;W^$x<9G*L8n!9M|@+@&7X;^p3BRu!%^{Eyz zgshon10VrPlbd*h#OkJ1%M_y)ypZbVh4- zNl@Sf!3RHw>q`%Y{vcngNokP;W3#0z@GLoa8n4PLI^*@lWtbP}G0>fL@?cY(hCqvL9 zhFQTFNt_%(0X_E>EW`Vw-o8ZmL!@h;5WXlybEeuprKnFQ?v&svXXO$|$AwkrB=^7> zHTq*Em4}AyE&LgyOfKQF+}C$1MlNpK{bP^zMgk|G75i@maGS*9VJWY2AD{G(=YJi1 zQCVJFEEXPLzNvNSwAA-A<15)tV32c?c<4{*PhDQ>;R{?8aJ(Fx8u4V*BejGUen{z` z%8QL=;o;79As)Pu>tE1|2^5l!$NA+vM6d5Vo~3&&r0PQ;1Flr@T*c;}rOhBW5`3WK zq2OSCy=%JY*jJ;=6AN{593QODb=eBrb8e zxyC)a{uQN4v4mTZG+`-Ca-;Ff!CKz0;opuQ@UUmlwHu8d=6jSfM`<$?9O}whFuyTU zbB^`*{rAM*2I;yRYF}d1@2?s%VY7!zz4Ih;K3_1jLjyf|IqmCTf7tvNw9^@`n)uIf zMgzKFDE|OtX1A>L7SR=)%Ce?8=bZYQ@M+>=qTxRvDLbd26*#+P?>Wb+a7myla9Tz`4ogZ<-HKj5Q(7qx9Z&qw%Yq)yQ#+8e8#hXud=mIwrfJ%Bm^$vSZw=O|cEEX(PbvrU^VCNccB=HwPf}}= z6s0EhJsQ}h2r81@pa0PNQ&jNf?xh;REsFh_Sl}zOhCOl_U0Z|fb6-7tTx9SLiG8TX zq}_!k7?grDj;)t=7~tgNK9%-(@O`bEalt;Pb2Lkk6DkN8!2qZj7_W#wZM|Dh(X`D2 z!(JV<7MBRJY7)y11L0X=i_CxSukU}+Axme=T#+^ON;h8`;MH;wdf z0o%lr>iVpaEJ&m}!xN}?mQAPlQziN17&xy<__OeTT=*la-1u_s;<|QJ`xVu@6%q-g zX5WVAXu(sCQLqk13H?C*mcM6dJ{{Pfh(0@&8^!v?xb~N>zMl?BVELxK{r>>qAI-DzhM)Sz zs8Dvpr^|lw{$ublui>`2oreDavP%;-&{RK~yd2{^Zs(q(p7qK2lF->}Q;mcP)np$> zO#c8{>-=G&UFcI?KoO_%lpi#y2WqH7thgB3Mmlp;d|r@Tw0fPJE5eepD*_Hw;nO1| zkCm~>JcG}t%toIhx<6vgu`;hu*~(uItLM4PUg^sO5rRaExo|6uK49#1Gpcl=xfq`&2N7trTv3$g7Mv>Kkbw( z6#8;7X-T_W_HtS@m1*)lbpF0ZHl5-rv?)jK&CRv;QsM#Clya=Sw=V=|uOq#8UMum| zrF~^#rr298g|)n&YJlT(!P+EVz_ltT|CNLG5y9^$^`L4W9RRVteQpcVgla7P*71n6_E$!4;f+Hbg&~^v;SJTs_96con@6`O80heO) zj8v-5@3s3G_O^1%B1DKwy9ElPC!f$)duia=+Q?l@L~AM9oSc)8GJUzNoexH{S^T*G z&9+N1I8E)-J;@&3Yt`eimi$3$CCf;x=u5W)<;e<)dVANCipI4q58W~z0--`4(-5xz z0LY8OUK4>;Ep+%pEPOP_^}+t4y=%hyJ*-CJ19uZe9tp5`jMlzAzuMI8s54X+M-$MmfE zXO?f?&O#1~2OT?)@v5sVCp&+5dh^@rd(=#`+b=cdF&YCqF1)eq+=RZ~nbyTwkxuAoU=R;ntYhR(*avYR-mkIY{sPBl3))+f9pC7FHOHPeWZ5L1 z9`2=I<&S?i(D~BGK=EIQLN1S_$W}!qXP5VI;PgIY;ZNa{UbW%BgU;~=@lL3#v2c;t zM$$e(1QPOXUV!#FuUpjoS>f##@pQfIsp_o1C8QwBHU}9hpoCHC#0uC~)^4MSow|Hv ze9rI^UgEx?^?^DrHKWG;=?CDDExED{HyQq94(jOwWmp6?>`F8JV(zl(Q(A$Wa9c> z%kD%GU8TyFh!n{n?m0hG+w-Pfi#z*MVR;%~#={P>C}{KVyZThqM{637Gmtte3=e$Q z9jth(NYSR-dvO(`AGs8+Jj3V~F_%8TEqd6jMH+DZ^GSK1IhEisIEsm3VJSdn70JJqkxq{Ohl)PR@mv>AFF(wcDfLB)^k1V3`%zqDj7^yYJmSdY& zbQw!%*ltLgLC2WfGbd1_XYUI5Oy7s{{6u}O9-8NSHTj>c;nlO4DAlu)?$oO5hwG+4ZlZ!)5WKMN_1Y&a({et}hVr z7?*bY>UR&|j|JZ08=9m|qGD(Li|5^1+(Ayz2IoDs+8 zo^f4Va>VMaaKXI@t{GLWP43NON{vN(CV6bX3p_B$P+O44saym6u~;(v9Pscg=_IIq z_MX1{SGqRb@D4q_Dy*h9$RK`oRPzek^D<|bQr^h%t6zq?HH!inWIydMf5y7|9XiWM z!Gr)u18D8|S3z(i#y0`{>n3Q`&P(8TCjeJR)+IeA&QGhx4)H}h-Bd^lq5{A%4*dEW{VVtZ z$S&egvLlY%jmzq!5noVvyW!V>eku4;>%iVV(c#pzd)#h{U_n+Nb>nrzBd=9uAdg!4 zU%~$X@K5a<;a7-e@dv?QiQXabn7C}cv0H1{83!R5WJTTwZTYSlW{NG`_M?{jSSYu# z|Iz(mhFIjrV;uU|a_HS}S|BjcoM&Iu?buZ9C+WW-b86-VhLamKFNX=9yb< zuLZgsX1@kMYR?$jc)Q~li5*+chC9P=9H@R$wyGjA<2>P)IXxH(MVX{#t&mTKm?%*D|#{_}Y zp4Iy7UNVZK<;SQ00A9XtgtGOCtt?E}yBB1;v-IyB{6n4t4Gf0{?ApBFUY1|xNj!G$ zgih+d`9G%>UP&N@0BKfC@DG2+p364FxlY55`OoyGM`Z=Vo``Yz*XhdJv-s)nq3{Ro zPx~ylk0GDNzYgLDRorB|vqszYfz^zCx140D>V3_ALh2emp{41%mXmvI(A?TQZUm^p zcuZ_oNRLgRZtgn_dRO%2CYmkI9m{9Zzdt{0pMusG)(7G?i)Xg#FeB7TgZtQ@Zwb=%8DN}o6M{x~`A<*l^sip=Yyvb# zR^nbqe!tVF zJYe-uPVA{YyB>$FVq9ELuId*$wxUDNbmf?Z!t>4)4h4Dgqk5drTOUh@$4$^wXz1kb zMK+^xa2h|B3wb&P$zlgMB=sJk0iUH|>T1CtwA(y=UJ zeN#|-mHC0nMo&0Edj2N>=s*|0r{PyhO72||j%$OdDMt+5=RN%v{{ZB@LdwAr9_D;B zBaNYeB#wu_O!|7(j5g5Q**2xC7LM7@Ba9LrY;+1eyRqO8ek)o?bp0;T^({z;f-{KX z&&@oT;Ya%;sUo@SYm3cdRlUDOl3BlZ8V{9F0rG_&gBd-^u9z-(-16}%mL9Lwsr+kx zw*LTvQx{*_muRzqkgj~Vfgunae!isFWvAP$FyGz7jKQZ}akFq6hTgY+f(fzEdJ;0|llwA)6$(ykziDG!?k#4g)ZMz{h+P)B0g3e;Paf1UJYp38>Wa!yoeAeD#xaKDEFwuVlJ+k_gpWR zDpb;Yo%WFg^WHMtx=9FfxuP+RDmcL|CG>E`d7_jD&5%n%tc%KsO#?K zdCV4)uq(r~V}Y?x8UFxy@sCW@$SyBrEX1k~r}_-^6`ySYwTduIVUPfz~E=LO?gvVo*RpLMAF*~3$y{i=mtMJqW27UG7|D0r=qCz&-4|N*Tv-9 zCLg9T!iv1NR(6qnuKoO^3z44Q`1SYbDtWJ=GN;JBEPq zjFlPr2*y|z=mvh0@xP2TUxoe|k66}aN4U8ewzG(VEbaWl58`9f>&1S*!Mr1fp+oyq zGSMxQ*#1B9d&Mlr9gqJ2R``Eey(cB|(LSASY3ipz@IH`rtybnccp+WBWP}7x%8?-N z*aZaFfJ@^q5qw3|1&)X3X<8(W^GrTlyOrzvzxn2e*QxEEal=~w0Bw9pzaBF2^t)}X z@@;Jo%Wo3Kg93_B|05EiITEnH@`GaLC<^9mlf%ee1>IE;hwx zmA<2c(igUbaJPmyE*-YjGSZnJgn5f$C3R&c0;vx9tz0=~psXczGXOyBslrhm@ps z23|oU(Q{ucc!T1%iM)Mc*Zv{Z?X=w%L7(jVDHS3ku$7A!lizv4?4Wa8WB9kjHZdoa zbemM|*%nFqmH@5~Y#RBD@5DN?y*wl=yPwb;1@vme!A8DuQ<_?Pt7ZD0@_r%wOYxlI z5i4mnj&`!y

A0eCz6YwpDiyiK=iv`5j2oIjo2^=!F%u;qN#ew00 z=k>3Pyd~rB4nubxz4e!xpl?Gwjy8_$5wMIa^uxklA@J>whxD6!neA+z>OvMjFU!n$ z0c2gw6^X_RXPz)SSH5lbE8&-RUVoyVi9x_i_eENrl?14>B#F|yRDb6I+EtBv7$=fwV`1|3NsM_8!(N)0e zFJf>9PO43JJnss&sJ`=_mj-5%SB@G_xfuAbXcy|ZA^%e_Zq z&3Q5Sk?@`m-&}a>MhX7_Uu)Ot*YvIJ8^>P?^=03s__oIX00$ViX(So^6B+z#FYR0` z_L^q$;VjaU=AIr)gCrw6%6HpCtdXS;?XQ;pgx8ML7-8UND#82Gv4dq0IA3^mUiT{sh2z*5v4eAhDk zkpKw*;g0NNa1ToUb}U_WzY_hj;fB_crIC*Cpy$kN43YyjbII%PU$g%Jwm*!#3*wK0 zmcqwX2?fpUcNWh70J{5B2p%_kqrs#JrJaf4rua9gg6t3uboUfBvu6Gk^I zir6dVk$~H}anBuB1lP&&UMt#jD7}x}JOIn-(8K#_d`-6e?Xml1`#fm+Pli4n#d!0@ z3rZvNrFT_Pgcwpuz{YxJy{g+(u)iwWecV?{>KR%o6~ig+Hj|O>Uw~Sli#{Rvk5C>R zxYb6PX?PFWmPuR43PHjq2>|`vp1H+c@N|C`?ll{~2Y4paQj=C?7MDL}XOUG3<8M+9 z-$UVfB`t9i#MlbJCgcr_ebM($K?l^=>%N1j z=^iE0Ej8^TQ8lIXYb-85iZtA1#@hh)dR4YT4NnLh*?0yr*ejiIKge%dh?J3Jn zYg*5tLh4(`A~_=guMejMF=JNSutq+G^+&dxlU0^wdJ&cb^Ww}O3C z)CMu)9|l2x0|PyjeniXNWQTx%6~V98-`gwTrJuwP09^QsNRK+MlBQHBzcVWG>U~FX z^ggD)8FX8l?KTVPE#oFse=6o9(4>k~gXnS&4{xP@W1e7rjv`#Y3)LUo{u%K)%rfXz zZ{A+)y?@}6*=ekraE>9wR>;zNjl_R4!mP!nv`D+TzyzOeohzlaz0;$z)wM{_KlY`e zhSn8eWLXO#A(yDYQZs?iIj(Z+Ubxw{t&-kW>T+0*VVn&9AB}hri@f=d+wk~`a8$I} z8Jg?I4ZN^gf2=F>p1X6=ey8-LwSv<}vW{D}DypGECl4b5_eZy{psOhaaU$K{;wFNS8PF2I}_-#v?#-BTrB9J?jS~z9*sGIyEOb%7Xpmt#|yZ{NLzv z8r8+lt0P^`p=5}D?lt?UgZKdcXRd13hoz3{80};Eq>KoMoq-z3EA0)tAg@8m;2t~X zw=bcN*2%yiIT#!cr;q;tU2(BnTrJ96*thQ@Wht}<+{?%$9u7$8e=6$3SLR;wKR@CO zo>)vu<#&Bo_1C%8$pkq^GMhVy0rJYDKbaz&5F2g?Zcjg-O7t%YTwdGiR#9F72?0^I zXXZx8X;|U;8?b&;$79ZTxV246>Khwtm_Ev|N~Sqvhy_APU?g$DQ=jheymAF~8a3=% zrQOGrvqv@zaBYxnQcCrF{m!GOrE=yp)S&wxRm0ebsq1v#PU~BpAB$|Rrts#Utjg;x ztWw7q0)I4*J{`aX>Z5c{NXG>JCxD7@_Yp>Uxu1)~4rH(E6fHw0q@xXYY+eQTbE-F!iC4TYmY35^xqS1efvEERovpI&RiqU{Syq4)R+>BzR+ z^pkg_2o(rSuKxp ztBw6nUALL0m(9E*attcxk8_V|#ng2#IzW&d^V_hlb4|Xun$@PCi;JwVOnt@Z27goU zTUvFdNp{I#GtWPrc@<}8%5%6Vd(76djTN&w#s=o~$NvCcu4z6HzxapZTOSX}GutK8 zvq|Lu-)FUrOFR7hZUet!Yn(S5!I=Pf5w-F z$;FtC)68;amSF3YSl9TON#L9ToRQT14-MdzOiVqavcKSdec}#hUWQv*avhR1I zKBw_Ni~J$*XTcWQyq4KWm2Gs(6(q@VBB)ePTmg;8`jKB7>DRi)#9tQNc(dXa*_uUf zomcKI&X(|wf;jpdbvf(Q`KGh+X}%zM;^)P_CA|AQRuC9;yL<)~$iS$PRPb4Plff;| zraFkcPi3fC+321Wvzq1$c))hRh!s(iI+i=Tl2mNVlfi7u9DaP(x33su7{Lo2 zt15<71EFSP#uqrxZ{rV&7SMlY>)OwP<HJBnY2GjK zh32(sV48iU^q7j$0Cpm-HZFN2lg@gRlU8ngH!_oRXCv9%LXb!!xdZ~TzTBf8agq-p z_w=uS3r;wAC|=C<@Eki%l{>X{+qaRQr}%q7hU9E?Yk3#so>i zx_lb^vs%Y*1)E<+scS9DOR&0q&`K~HT#cKGu;-k0u6=&hpxxbBYSw}$%Yr|I5HpZ^ z9=v^XTUu73bv}`60?3ISgr6%rF(FxiAZ`1q56pi`oJTz4Yu{7pVV6gj-O+wWt!b8V zP2r3G01{|7Flkr1Y-p0{me8?|kXqY*;x+q+%U%vP{HjULK;t#q_+$PNeM#Y4$zB_h0NX2;k0-g@Kp#RsI`gJd zqseiYkw^*&1b*zG;=RkmS{0T3v1oJ+I#f<_;FFHr?>zqioL9y^9Xge@^a$cRFkGt# zCu0m}?*1J`eXa0%7<9?5@AWBd#P-r{NNy+HY*))N7E+lG#A5+~QIbw@K=~}rEo;xA zrx0MFM-Jx*u5ToLGw}1_R+Bc7Z?0+&+@EGyT}~mHxXi zB$dOSJ+WRd@oL)7Sy;GgC8|Azt4%aD8)JzO(R;QH(=(;j1t0Nh3T# zBx@q=3Vu~C3gDkye=4Qnui5X%@##?7+}K4LO&K$Z?g&(QM#>M7BAKGRzctlOK@=NEpuVL0)e+ zh&*9>FZ8WX#wxZJj*W1UTahfA@~v-gA_ChG43nO7*PcF))IVfftzOnWI!$Ih4%MAr zWwGAIMvb>1ZQDTuxj84)b*}IJ8CSyhH}=|wp{mM6G5LN(5u{OIFgX~>1oz1~?@q30 zrM!njFNHYhuFwC|{NM5a0E>K4;=B2-bz6tj40jJ9nn&|Yl1Ku(2N^gx7*cQtO1I$e z6Iy>^&7*1vCYIh|G&yc#R#F@&IKt$T-0|!>*3jT@4qR!{>M;3wezgkA6wZLDjilw2 zkV9-?hhB04TyvVs(Dadg;%!>m-^-Db86ylb5m}~K*}3c&Bzg>2$YN5DHP*-L95aoS zYtvNSl$u{7ZsIYe>eelHH`!X|6D_hu!~BPaVgSZSV7Le;??VUN87(XL5AE7g+|>^z9OOW0KbTNC1*Z z;(fkiOcd^oqd0ijsTn!1kHpegh|{S{S;uwc^gh!Y#uoPUX4aDTZ>sBkJrB7&C9AjX z9q@ADb*(Dc-^&Endd{39V)}j7T~~Uy%o}J8y>Zu|u3z>{)2Hz7!b{C2T~g}u>q^z{ z^!tl>NNBC(w{hi&G6N)S6R*m02?e;#T=)<1XW=KoOMe#lzv33R4W_l?yV)-8VU8K& zYea`|OK&Q4Nt~%HOq(#o^Z;b{zq3bxJVD|whh8A~i>kvWk$L02cJE%bwwZPxvRnmN zQILRFD5KNYp#=Vsk>jw{RXVcTI%~Q7*PSe7Iu)?Az8a63-9BEYZ}!XkkCr)32R!%3 zYPMm%xWhitv%g=$w5GNG&A50jt;7?iH!1#qLsAL52*@41EAG{0D5njN%ibNu^3O-+ zQIg1B*~@8j9#zzUI|J`u&sW8L66e6*89Yy*LvOJX=I$kpf!izunGp|g$N<{I&>H@X zBXv7l?&Nf@%un0j;OxTk$KvLR5X`$Ex+9ESN5o|NNP}tjUwZj|B%0_$Qvn z37AU{QRz`HyVr>B~_bp4G5 z%`d~%m9-ff{mL_D6g&)&53N%WT0{cJ0N&hXbJyy7R>N5=2y%STKZNoB0PFl~JtCSv z-ry0?3g}Z-(_`gvmt9H`)8?Kqzhaf{PTM6Uf`~{mu6Qao6*xQ<(yW6#{HKil za%F~)ucbb z+Qy>ZBwH9mHm7+lytex#SYuIdoxqmLvoeySJsP?(2mB-2?0U9~a+el2;jZA0LJI`* z7&KCC;T&U;@5dF$C4xz5rpGf$1St*L=C|AE1nOi9cmpeYfmL_+7e;7 z#3nU6w#kpY0X!4e*woQn-`?9u=`n^_HyxP4Dum~p0j9r;6j<0^V zTN$0LnTS>eQJ)-ua(FoOKT7OxJW+9^*|b)R}xC@InGvsvPk*dRY^&t;dJ-& z`5YgGya%CP-bV5W)*D#M&Zc;xmSxW#PUOe@1d@96ucmw<;D4~$%?^=a9=WQ;0hz2G z;UN)1PZC1v$jva?2*8y(^0@-IFA3^8cZOsB)k}R|3(3rpSZfeWV=jyLRieYAAMYkq z)tNkSmYPdkYcXmzz9y8t328QS_yKOR+nz%!y@!qzExe#kC)}$(>Sk4@wTbqEl)s|v|H%D(WtV0vNLYh zZy(*U? zXsNU`50)c7%%dH8@m^i0-@U$@eWOgu_*RcN&nbphUrpP8TFV#r4+Kzk5x-C3$WwrR zmFc`3rqrK9+{4P8BAng&{{WfoM)ucRxV_M|FeHlQVO41|4003-vIfT+PBZJ!*9B>B zeCE@OR8N%*&Jx+0v{J5o_>u-p!u5H+DnPbmY z#^u8S`Eyl62G!zeQlf)OD@VD~=;@^C-YJ#|;1^a67}~6P3vjsOBxJ5g73Z3b`(IxO z4op^O%LR^3;Ba&A$LU&f>V<9_QXHf~LXvpIY6l;VYmt)RgXL`m%gF<-Smc`YsA2VT zd+2=5agI^tN%g<^ey330R5K<<*xUk1>x}dHk&ni@8(m6R?Zo41NE|9IIaO?&gO0wx zg?aQ>0%>KFlF?&e^})^$>sKEAgPqHSj1%vZ!2WdWQ0CnoSZwMEIc&NfnA-G{UE4!( z{*#9{5@CwDZ{Z|@FhL~b8t(ife|&7AzqN^`yRvs7NQsq%qy*oR4%R1YZpHz~Cy`zq zr`}6Eh{^-p+yW6#@Gdy~0LlDo(0noCID9h<)~aQeDV5Su8N*AsVX>c-W3eN*<6b^9 z0{MN_sot?3+6~j(`>)~G#XlKnTGp4O5-!M?rKPgK%K*8Q60peZK47R$19Ap&zy$sE zrudT2;&zK8X!kJx0B`B(8{9;SR1o7nS!|KLPZ>BT@fG+}t9(T9rInS8`gHSHMs8xc zhT$cX&JtTFk8;VJj02818OCwNePQt9_LKO5;n{7kFA;Thh1AP5IJUg$g0ixPjzGiv z>y!QASmf1lIdypAD9hdInfP~zz8S+frBaP@5MRc8SR(&!_=4cZf#;%H7778+eg(s2I1a+@Q@W+p0)hr^sTi7pcD#C{96 z)o*nDa3#DKYO+UdA;KccyPwLGVS_0E9Bv?<_2xJ`xXL;oK|>4eDJrz(sr>;9@3a+Y z*p0(D&q|s(fjC(k->rN{;SY@#+V6*SPY~$Wt2A>!o_r3*Kb>8nZzUZj?7#|d1rSR+6yRTj^Yl7L>ukaT*9pg1~!ZU84mHd zNgf1H1Pb1EtaH(qBHpg+;1ud$<#3ooMle{s|z0nc@KkI?0yuOYd#*;Ex^0e@1~aI zF5%CYF>+K9j1S>F5zyDi(ZZse{&9GXe91_gE2}Ixq}4`quPtmDJivByjsUN-8nj{*7ujlK*KeorluZLF0MVjGteKk%}JBK93GtwvIs-Ho? z^slJ=H~#F0%)$QfC%35jFu5L z@*wk5VFwsIAH-8URpGx6{6O%Qqu}2YLT1zTSXvoW@J4x8Q`wZ^l=dRLm*I!)gYZ-1 z3PGdl_i^YN5G7xdvB@as2aq$7o;%m{ANxyw&dc$);f3ad98j-_ zw8b}CRmSn=!*HV^bJt{ph95)NSM#&u8w<}3>vF}d*+~|oYa>B@XEbga8B+n1Bn27j zq#O~0Uki=Gs#R|Xc%RwcAMvWpGWQC)RfV*BKJ68C3s_^4N1owKt<{;svmdA=pJ814 z$oq=Mq_3|kKVE-I=zp~I8)uG4ttXP+U^z05ho*cURC1h3dE|vb#az0hT!E7k>C*0Kbo=x4zc~qze@F&)>lH7u< z12%m}$_V!LtHGMt{Ha%Kk&q7u>T8D+3#}3D<(RHXe);>U>~&3R6wmf_V~lPfpOj;u z{CiZkbFI6-hi8sCA-GAdF@_FWIEV_&q+&3Bf0n~QU5GKD%+ zqWSlB=(;1Z)Ah|uR$-)A$uWxjMuld5?IVr>`9^;JLT>4i#eF;Ay$b72@dUTO*t&(H zU&#zJAKp%|n=6QtVDXj3!nBwIGJaA(&jUX_cxKWITPM3O1;lWLp5_Q&$dTjT2=b+D zkid`?LYBZM2M0d=V%HiTlWnELb7o3GDVF`N$$e4U@Z$y(>>cxJa(n{{U9hWYY|2<|(66;bq1^kwzP95wz{(XFTH-*;-l2 z@he7`!g|h@mXlq<43_uqj6TT}Y~;_iIDCLXVb0J;HS;(+KE|Sx+o|>W&JuBimhb{P?` z@Mjr3^Ij{dXxi_C^)=EpKw+2{)dXbx|GqmxKP7ll`KYbdy+DL zTKY-gVLeu;^RkXEgyU>PJ>|LT8n21<4NC4!PI(%8*?5vhU%sR6vCk(X*1Y8T5^AXe zxqZ$Vano+oyT8(uUC$%SfwTk%3yhP~kH^xg{{WhS>!6plpyrE(dsclXQ)Vu#|;o+&UxF@J^E35{+(=>%7G<-C~c}2DmeLo9Fd;A zYOboAq>9{vuCZr5^2B1EE+>*Ew6jybRof>V4V?A;E3r`3F2-*&gkd*5RrK{U?PUT; z8b;f+GW!4yO;}&GU(C;Ho6NXX9q>2={d2&tqW%^B&Hgj^gBr|j2A`%#LmP|0%A^s= zMISSee*@|(^h4p-?91@O!0T;2#i7@4pg=s!wN{8eFkD0i-1=_LKD^h^<=iodukTvR zx%j6U_~DghZPMp;Cceyj`Mr_(QQ@D0{{Rv^W2Z|uhBOPUQV_ul#D~jVfw-19U&|)F zcF*=i_?Y(p0BD;=ov$Y+a$d+|=z5F^qOSrlNH z?x6!EiDQz(qT}%u#dwSMZuqOFPvuMDtH~n_OUnW*prHQgMqo)Dy>rce+S+J(jF5vg z8$jm|{D7@Ev?kq$a52{y&*w#64Z`gSw9GJnNet>PD!mvx>GmZF?J=MP~V~$YxQ}J9zm6>T#3mO@8kDVE7T?uZy~5 z7V~*_I^Chgt?6CcaxhX%a>#r49Y=6~4g5{v4O_zABA-CILvMGdtnuAte(R)-5!;`j z$G0```Ib{WJh>*cdo%h|fP77%oZ;PEJ8_(C%?{V?_YT!OK_0b!wrZP}+A#{OV;ED{ z0CCt4!o4d%*RGRQwc8%sm5*fPk_3@PFbkm=+(7%of_dQQJ}0Kd91^QSdwkA0!9D%k z{F?TE4aBbT>M+<`&Eyc~cv0A*s5|$S1YrB|*1ktHv?;w0*)sXMk#(v)TlpVDTj@74 z6_ZB>;@;!;iqH`(WDcZ(kO)1Edyj;s_=(}0J9+fmS#EUMfN>FFExBCdcF=c3axs(u zXQ(yjdL71}eIAW%pl-Z-2~})Gw7y-%>M;4$nE)b40si(KM?Qn@El$TzkHgwlx2GrB z?cZsXM8ZfIu=~o&NmkwRkl4xh>&?M6J+3-5`JFe>uKs>U;eIsd(xaERJUXe}OShMq z%vx#_YIdS&VS6WYi6fV3aKo~YNM-aR@c{8ychTI-IF29{9l0HPbDG$maTdjOQInJ$ zWDehrJ_}}2)7%U@5ZE1YU)Fd!a)eT-?$7g&Fs)9dSx%IBQ`Xz0d6&e?Wd8t!55$PU zWN57X=QIGcksNi%!5>Qd zPvT&{lfphDiq7qA8SK=%NS@A4QVNT#>Qi7kbZ$EW9%phHaUIZ)eDla~M)P zue3Jc0l^M7`ihI;AB#2L0NZL;8aAUPthctpK=>tm(5w_ljg?@eW2QP+b*A_qTfDv1 zJWnj^YYo{bZLmYd=cJQuZ(Qvw+!8qCSCys=S{>EY1lq^vT3j?|Ycz2=A)6eM3XXk9 zu5`6NvOJTABil>*pa0e8{x^81;x47H!QuY^5Vh6sggipR;==81)>$px)ND)=sU&5y z8!Hf0^SiP5zR=kCT3LKq;aBscy^>o?+ae5VB4Ul@Oo!%7us9&FMpb2O;=ca?@Gpvf zF=_t*3Us{_MX|Eiu5=5nK{Xp4LfBlNvKbZNl%PIp@tl?8E6+UF!+#Jp8x2!dp5-)z z@V2|=G^(*o^V!}Ya-S%WvnwGbO0zH{Dsh2a)ZZiJY{xB(sz%S}=6M&1>^|SFl(r%^ zoCz&w#?wCK-it6C39v$zz{?JL=Ah9cnp<+SrsR)_5xfook?!`h5`?}eSAp3tzzISbt%`^dw;r(V_9>b^Yi=CrojnFTK9 zjaO2!mNKGNOpWnK2}2-UlztodNFz1M>bF{!g{rl@a&40!BLmAQ=so>;^%aSz>DE`a zCsNbZqMc41I4Vz4aoBnuhuHPwqdQ3{qtdH}jMqFFz2ZFrT_;hKOqry3u#&+c0C|y0 zyQ6-8g_MKGemLg5{_Y7aW?)Ad@6#WM;=8>c#W(uKn`hx2QrzCXrV_$cIk<*A^ACOT zobV4SdLBrm)pR-SVp&-Hj0idY5)KM5JjUa?whyLj+MHC;$ws?g!W!Ci4Nlvf;PHFG8MwB1@t1hf7%b@{(bX_Hv^o@hnBs2gPVmn$9& zQmX=z2^S=8DmXYf;=V7J&56vG#iDQa2?TcS>~U4rNuMOSJahP0p73ws=yYJQp2DnZ z(~YLOo{OaTusy6=UZZOq@gox(N4ITX(oo<&pTs?0)H1Kl@byjR&zN{ zcNX3H^cCY&rsV8?p@PjIqUuF0dbj#rohE~GYvxZi)On6L+dGLuN$2HZ_gIA>dgmQY zNdfa--pcJ5wZbFDsV3;wSHLddbQ=c%1B?K3ip8|KisB$7-ENJ)d!w-uy#_#4 z=rVG9*LS0MYVT5>Hd{8fmI%DrU5;bIj1v6{mpvDNGr=`@iE>l2+{Y-VQx{*_bUR%V z;tezVE6=lrDRh}9GfO5!S5FWOv8%=#IV2EB;I>W&H7AdJTWeuwHLb0*5?^ag=TAH+ zxJdW08y6oaaey&{v~$*{xYev|^t-7ci5}gZjI5&(8JUBK?NE|HZJ}L{KnH5^d-HR7 zb0ziUf$lCOEZcYhp1^hha4Y92(2qYfw?6u%O0{CuKAK;*p-w$oXE0f<$O0x~8*U>3 z@L3z5x^cifXCBp)d$u-r$ubeJuW}CqKH{&s+szup$P24BUmWrV2hd=V^)yRi8G#6L z`(isy$hUbB2IqGw7##fA_WWz6vGEqIqv}@I zHrLPQK$~MRxkil%%LTz5eGdn?t_s!K)^GHOklHJgRUex?QbD(Q_uZJ}on64X6l1O~WK6s^Jovw%FI~ZV$_B@Q& zN2h91Sjg6_GUh#zka+pNQIn2WoaBUI>35Ob?vfiAqj_Z!qbo(6h9C{t z=n3Z-88x0;cvSXH=+7%W%V{RDG_U`Mt; zBVO%TMt{3q4=W3dl_<)*m%C<-9|m|U#6CFJEi7~!IW;TUV_6wcWmE&SZ#)GV9FlQg zpAHehu={O{V(G{E_H3w-LkT+grjmoUh6{5zrdz^vfCV3FH7fd;Kckh5RO~YPULq z{`No)z{dmIJ!{ZX(hD)0Sk^r8zytpPuU_sW6qDtOKMtjbd&t4J(4a)k&QGw$dHrin z*3uY{`ZOUhd2X%wpXpbHypkN8nxE|KI3Fm-Q(O|P+SQ$2%duZ-;kTUe*S$~)o}&Za zwPgl1;CAHqs)dl?j^6a4BBc|Yx^r&()Eu|3TKG5i#`s#={{V(AJ|g&gPgd2eA}f4i zOfx~ejc^>PHBR6ak2iOWVq^5!*eMm9sd9e z{zuZk4Wrbc_?x77CfLuXTwTnjG?@Zi0~$1uVBiFjM$CJ*fWY!F4Ss=m169y2JR_=j zYe{+SZ>_|!-NAPtXJ%kdLBfP}WyuGP*v}RDQ}9~$;!lV=XNoSSX=k_AtWh0-4Y0^F zo=;UhJ*)Kp0O7C1ty5f?px2mOS;Zd9*(3^JEU$%?_~XosjrrqnCydv~RUNu(h$YYB|T`KM?OiX0 zH0>)?v01cbU+l=_mOFiiDr1I5jY5&s0Js?KUX2c)1*`#MP>0)(&cCkkxu-oCPr5(N ze0EUi;wn;?*>CV?fqX;ogExonJrp!mDM zdOWszBg~dkT2FRvQxIa`5y(95PnJRwFbUhvGhcE1K)=y!t=dz6nxNi+=cWa_qE~{)}o-^f01T0~WNk4JF?;s2ck_-Zc{*`)Hn_64Vh?W41uAS6oHEdvAP9Q?77 z^D*T7#C6H9ojh0JttUmd)io!!Dziw5W#<8t8mJ8-uLlfs&pE;MuISynois6&;Rd>& z|JLfiYCnfwFoNI3{{Rs*e>X?gd@U>*m4>5W4ZF{z%0f>B#WB6Dq}t$~N@O-h4Ss8D zJ}aBY={~W!Al6b}I`#qwnv;%x*KXf?VI${EkTa4ofg1)x+#}yf%sS8PsVTA6XHL^9~y}~G?GoHNhWOW<#dTi-Gu^XD!IluI6aMY)}t2f z_Z~h;nZuUT-5w)zsI=O5+V9jy6Ui>(iUJ8kDUhJ)f_AtAj!rNutkE@bbvnrn&`DG# z=2Yv22P~rsP~(xo?m6bQe0kuVUqsODG`|(;t)bmsvA8Hyc|T~32&9%KT&adtAhNIA zZ0F$#o3m%F zhH|9@SDNbj#_=z-`PpQTnBRlE%;lcYrYzr#XbYNO-D_IT4uK4 zu5H2l!6XA+Nje-(A_M!2P@H}BLJwz?B_M> z#X`JWS~d8d0>xFp%~PoPp!R*ee)HwoH2pThbWKCdxH$RD44^A<^7HqxlarCp13hbg zZwdH2P|<8P4I@*U8~J8v?ya6bF=9-7vIziObAVLjoaITbirYu{eA+=)lKV~8-O!-A zR7-V@@Np=8tQ(x+RPoWzTB~`f_*Pw0Pti2_=Z?sEKiVP*!C9mY`^Szkw>Vq?x#Jz{ z=d%j+Aud%77h~_TJPsbLJ+$iT`ZLR}d_8)Nc^#-*k!lM`uphXj4dWxHHOrAKZH3MS zd)J9?dO2?+l!kRH=ujm#d0EY08*zpQQMMma(ydw;kj-1M~E* zOhs8s_;EhZhVooC7Mib*t8XU%03%~V@U4xC!#(7SaU;j(D#oFJB<%u5aq4{zJ6Bz- z+-Z7Uy}b8j9W7mat0;!Yk(ULYQaUDh1RUp}uN|M_h3}RZNwkUwUAUT2zGd6pPespu z52kAh-&eiVu2|jNubC!GJdfYhlh^PB*ONR1zPZ9{tVB%~JaMPcl*f z%P>{wrO7RU>Q7VNv*eWd>=Wk+$FVr%){T-qtWp?P%#pCGD=yVh+<Y@5t{^J6CTkQ7x<7NV~kWILEI+`qkT82rcyO(k?ux@^U-k zsYX#&3}#tMwMn-2Ms1a)mHvv_vYB#C~=CCj3&K=W4smB%RH93B`{Hn$|ZS>JE- zp&>2R5i(nG#`E%%?8iQpYR)Z7NVZ)=O>+grQGM_M1y492-A- z!CFLfCtc{os2=Oni~(BdEgAE#F0X@p@prOL{=L`8gj$=}up>723dLk%Ncp&Iem#Nj zPa0{zvYr-^7WYqL{#gW>V<#*_jDpB}9-#4@Vzc(&=~r>uUBF?Hl|ne-WCY|f$;UO@ zSw^>y5i(XX@?sy zYYLIE(N0(BQMhlFxa;XuWIKjBFC0~=k%27dgXvV{QMV^J6|@quoY_iLg~!jx>BV8( z2%~?MMn_><@-gQFp4CuUNj#$?>P>c2X)R7UrtM?#`}V}})Ot_F3)|^Om1(KPZ+OV3 z1>a|tjP@BqPCJ_U9uy#Qnws0;Vo}TSfCr!h75KjqB?_{AoBYr8qr&V&t7RB`IF%5MgIT@EtUPE zgiGlzu0ZUoJ;aVN_z_->9loWi%5C)YJ#bv~2EVW}Od41^T;IySBmB_gEL(ZDE0g)< z`I-L!7Vos%t9xml5^gQFG&04XF-dS)eqWfWKz9M2ImZCk&zh!}ss8}NOJlA0b5M@k zP`eXLWuu^NqBl|d=koLAu~G7u3_1cciuR9)GHKoww~WcEEEkU%V8wxTEW1aR4t{1i z1B~;InXfVM#<6jwcwaDrxYuHK;1PeA$?QuIj~x&^X8^BQ@ooAeQsT`h|hi5Zg_w zW#N&4WVf+FlEpw$OJHs7&MWE96Zo4*xbVX0U`uypr^^@)>H}Q6zwaa~leak_ZaE4- z;}!Ey!^^QB_NJ$E9I?!keVWQy4iYy>w(TibwRYQj*4`&ythC9*Zo;m zDS$sbSD1Wj(dO2EAKqC-VGgGZl13-CoP4suA@b%xe}$PC?LC_wwdz-QHg*>BUR|(` zIDsrrABA~-v*WEhRJFPA;>;nM?HNNaR0pFD4k!lSW>sx^ikUUX*A6kgTe3q-_KYfCqeJ z<2-xUsrW0z7CN2Wce=&-k6qK1Q%*Na=0Ld14o7xw8Hgtbj1gQ^eicn~Pm=aoS*Ms1 zh2t^q>yyvk$EXAzdF@=Ba@=W>$E07|?Qr3sxJJXPXYQWFXM@nz^dyt_cQ`ThIpb!1 ztM=c8{{R_utGizxBk5iwvCL@p(W=}cE^vidl$`-QlY@XUwDVsec#GjqvuolJplFR2 zsMEO?@huP@)R^FEdE_FoKL&Hn%kU`b>41R&-`1>Pb_jP>46 zDlmG0E786XTX=uP+O+rjhMZv0?BsW5!40$@`DOtMcCXDQdBEU`=QY89@dM(Xt9Pp1 z-QG3B6BK532<#jESVt;~82!~z^6`OOUx@sF;wwhG@b;Z(G>aIImmpA5X%i#@$AC9y z?tnNwEAz}wOIs0ASa&~pTJH8s(EZN^#k6p^N_C?iShVcAzc$8vOV>30Yg)X~ygaL6 zp;=1Eh#UQJkL5Cx*9<{mnc4y3yo5#~$WjOg91QiYt~;nCwm~_BJ1PC)lWQNFuGS-g z{?7-$HAC!3Wq9qRS%6P5h|6sowvtac9XgKx0H4@V!TUHUE{EpW{KaBwx{`Xc86lDW zWzWmpaB6fjD+VWa&U2n?N?QhjkC~M*@Ou%F!Nz;_9Q3MU2E!jUcY&4d^~vWx)tvD0 zmW-+xsnYkL&AVR^kXAX7++%J5+J6&+U1g4>w)-CH28s!KI0v7h&p!3#s~eN^{o&Ug zYtp zdwh}UmNxG^mqY-O#tUp6PXi-82d#T2hrR@O$5^zF?OJiMgDSyg<0=kv#PB)6$6hP% zIOWmwh{|Z%O}&C=q){RqeLx1BlbhK?PUPftPEQr}*j@vLm$s;WNyHyY3|(8S1|3HI zTf6&@l(kRUo-Ieib6MKn`P!~G#~B~HI0OKv_**>=2t5eJd^~P1a83!DkbH*$8JHmQdoV1=tmWaa{86^Epelq+{XBz&cdZKFtn(FEaFhK@g z?9vBbPtBgS^PFFlQNucMqPzYU{{S=X{14-N!!`QVTx{;*<83X!HU9u4dxwN1@ho2s zG+Vd0w9-=JTpwk+$8K<$+DgRg-(A3Pax3f4gZkIP1K?c?!?5ZeA<(=`BWUC% z^6uK!ONiX7wX}%dQAHz_E5Pb8n)s8!I`V(QsMhW5?K7xpl3D5z-rYzyz+#vHEtjt2 zz-(;IQ;9EyS$Dvceg#cu9{T)oVBOW{O8)E>X^}BShdq>XeQV8ZWm}ndlk$wVdJoR4YMP2% z&WdH(60k)hB;=fO7nAfH*Y&fZ6q0=p^9Hsibt=kj>nC%G_@0(g-`Mzy>rQFoyeVuV zjwO+pd7+t+NIx+L8TH3n>t&J&(&B##TE%M)p##C>VYVte9oY@{4&j!-1JqM*JTG&r z+}LVY_Wn#-Q4?CG?ejd`k1_GW#=LDzW(i*_z??T#{MLl3ymsG!s6LXfLu7v&4EZ`yCApC$p@So?zL?y z+g^y+>3S3v_EsBh;ok^IRTX&T9Fy3A-}9zwz90CdHn(}Kcz47W*7lcvTEwyjZ?iOT z;Q3$z6d5s`9-MbI7MtOJi}nc(#;>hgNgBx|B literal 0 HcmV?d00001 diff --git a/src/content/demo/cropping-controls/index.mdx b/src/content/demo/cropping-controls/index.mdx new file mode 100644 index 00000000..5d752935 --- /dev/null +++ b/src/content/demo/cropping-controls/index.mdx @@ -0,0 +1,104 @@ +--- +date: '2026-07-29' +title: 'Cropping controls' +description: 'Interactive image cropping with the fabric/extensions cropping controls' +thumbnail: 'cropping-controls.jpg' +tags: ['cropping', 'controls', 'image', 'extensions'] +--- + +import { CodeEditor } from '../../../components/CodeEditor'; +import code from './code?raw'; +import cropModeCode from './cropMode?raw'; + +Cropping a `FabricImage` means changing four properties: `cropX` and `cropY` +pick the top-left corner of the crop window in the image's own pixel space, +while `width` and `height` set its size. `fabric/extensions` ships two ready-made +control sets that drive those properties for you, so you do not have to write +the transform handlers yourself. + + + + + +## The two control sets + +`createImageCroppingControls()` returns a **complete replacement** for an +image's controls — twelve handles in three groups: + +- `mlc`, `mrc`, `mtc`, `mbc` — the side handles. Each one moves one edge of the + crop window, revealing or hiding source pixels on that side. +- `tlc`, `trc`, `blc`, `brc` — the corner handles, which crop on two axes at + once. They use a custom `shouldActivate` that hit-tests the pointer against + the L-shaped bracket actually drawn on screen, instead of the usual square + around the control point, so they do not steal clicks from the side handles. +- `tls`, `trs`, `bls`, `brs` — these do not crop. They scale the source image + *inside* the crop window, keeping the window itself fixed. + +`createImageResizeControlsWithScaleToCover()` is the smaller, more targeted set: +just `mle`, `mre`, `mte`, `mbe`. These resize the visible rectangle, and once +there are no source pixels left to reveal they scale the image up so it keeps +covering the frame. Because it only contains four handles, it is meant to be +merged into an existing control set rather than replace it. + +## Assigning them + +Both functions are factories that build fresh `Control` instances on every call, +so each image can own its handles and you can restyle or drop individual ones +without affecting other objects. Replace the whole set, or merge a few handles +in: + +```js +// full replacement +image.controls = createImageCroppingControls(); + +// or keep the default controls and override just the sides +const edge = createImageResizeControlsWithScaleToCover(); +Object.assign(image.controls, { + ml: edge.mle, + mr: edge.mre, + mt: edge.mte, + mb: edge.mbe, +}); +``` + +Note the `padding: 0` in the example: the handles that scale the source inside +the crop window position themselves without accounting for padding, so a padded +image would render them in the wrong place. + +## About `enterCropMode` + +You will often see these controls introduced through `enterCropMode`, wired to a +double click: + +```js +image.once('mousedblclick', enterCropMode); +``` + +That helper swaps in `createImageCroppingControls()`, draws a ghost of the full +source image so you can see what you are hiding, turns dragging into panning of +the crop window, and installs another double-click handler to undo all of it. + +It is a convenience for demos, not a requirement — and it is deliberately left +out above so that both control sets are live at once. Assigning the controls +yourself, as the first example does, is perfectly valid and is usually what a +real application wants: crop state that persists, entered and exited by your own +UI rather than by a double click. + +That choice is also why the first canvas shows no ghost. The translucent preview +of the hidden pixels comes from a `renderGhostImage` function that +`enterCropMode` attaches to the image as a `before:render` listener. It is an +internal of the helper and is not exported from `fabric/extensions`, so there is +currently no way to switch the ghost on for controls you assigned yourself — you +get it by going through `enterCropMode`, as below. + +**Double-click the dragon** to toggle crop mode. The full source image appears at +50% opacity with a border around its real bounds, the handles become the crop +set, and dragging the image pans the crop window instead of moving the object. +Double-click again to put everything back. + + + + + +The image starts cropped to a 500×500 window centred in a 1920×1200 photo, which +is why there is empty canvas around it — that space is where the ghost appears. From c2df674f3cf353cdd386de26c3aad96a9b6ce8ff Mon Sep 17 00:00:00 2001 From: Andrea Bogazzi Date: Thu, 30 Jul 2026 00:24:47 +0200 Subject: [PATCH 2/7] docs(cropping): trim the cropping images guide Cut the code down and let the prose carry the explanation. The interactive example hand-rolled a resize-to-cover handler over ~170 lines, because the real helper was not in the installed fabric version. It is now in 7.4.0, so the example is a barebone image plus a single `enterCropMode` registration. Restructure the page around what the extension is: how cropping is really just cropX/cropY/width/height, what each of the two control sets contains, how to assign or merge them, and what `enterCropMode` does for you. Drop the install snippet, the long usage block, and the "testing locally" section that pointed into the submodule, and link to the demo instead. Co-Authored-By: Claude Opus 4.8 --- src/content/demo/cropping-controls/index.mdx | 2 +- src/content/docs/docs/cropping-images.mdx | 105 ++++++++++++++++++ .../docs/docs/cropping-images/code1.js | 27 +++++ 3 files changed, 133 insertions(+), 1 deletion(-) create mode 100644 src/content/docs/docs/cropping-images.mdx create mode 100644 src/content/docs/docs/cropping-images/code1.js diff --git a/src/content/demo/cropping-controls/index.mdx b/src/content/demo/cropping-controls/index.mdx index 5d752935..8c19f92f 100644 --- a/src/content/demo/cropping-controls/index.mdx +++ b/src/content/demo/cropping-controls/index.mdx @@ -101,4 +101,4 @@ Double-click again to put everything back. The image starts cropped to a 500×500 window centred in a 1920×1200 photo, which -is why there is empty canvas around it — that space is where the ghost appears. +is why there is empty canvas around it — that space is where the semi transparent layer appears. diff --git a/src/content/docs/docs/cropping-images.mdx b/src/content/docs/docs/cropping-images.mdx new file mode 100644 index 00000000..14c9a4dc --- /dev/null +++ b/src/content/docs/docs/cropping-images.mdx @@ -0,0 +1,105 @@ +--- +date: '2025-02-25' +title: 'Cropping images' +description: 'How image cropping works in Fabric.js and how to use the cropping controls from fabric/extensions' +sidebar: + order: 600 +--- + +import { CodeEditor } from '../../../components/CodeEditor'; +import code1 from './cropping-images/code1.js?raw'; + +## How cropping works + +A `FabricImage` shows a rectangular window onto its source image, described by +four properties: `cropX` and `cropY` place the top-left corner of that window in +the source's own pixel space, while `width` and `height` set its size. The window +is then positioned and scaled like any other object. + +So cropping is not a separate mode or a special object — it is just those four +numbers. You can set them yourself at any time: + +```js +image.set({ cropX: 710, cropY: 350, width: 500, height: 500 }); +``` + +What is genuinely awkward is doing it *interactively*, because dragging a handle +has to change `cropX`/`cropY` and `width`/`height` together, in the image's +unrotated pixel space, while keeping the object visually anchored. + +## The cropping controls extension + +Rather than leave you to write those transform handlers, Fabric.js ships +ready-made ones in `fabric/extensions` — a separate entry point, so nothing here +is in the main bundle: + +```js +import { + createImageCroppingControls, + createImageResizeControlsWithScaleToCover, + enterCropMode, +} from 'fabric/extensions'; +``` + +- `createImageCroppingControls()` builds a **complete control set** to replace an + image's handles: four side and four corner handles that move the crop window, + plus four that scale the source image inside a fixed window. +- `createImageResizeControlsWithScaleToCover()` builds just **four side handles** + that resize the visible rectangle and, once no source pixels are left to + reveal, scale the image up so it keeps covering the frame. It is meant to be + merged into an existing set. +- `enterCropMode()` is a convenience toggle, described below. + +Both are factories, returning fresh `Control` instances on each call, so every +image can own and restyle its own handles. Assign a whole set, or merge a few +handles into the defaults: + +```js +// replace every handle +image.controls = createImageCroppingControls(); + +// or keep the defaults and override only the sides +const edge = createImageResizeControlsWithScaleToCover(); +Object.assign(image.controls, { + ml: edge.mle, + mr: edge.mre, + mt: edge.mte, + mb: edge.mbe, +}); +``` + +Set `padding: 0` on the image when you use the full crop set: the handles that +scale the source inside the crop window position themselves without accounting +for padding. + +## Entering crop mode + +`enterCropMode` wires the whole experience up for you in one line, typically on +a double click: + +```js +image.once('mousedblclick', enterCropMode); +``` + +It swaps in the crop control set, draws a translucent ghost of the full source +image so you can see the pixels you are hiding, turns dragging the image into +panning of the crop window, and registers another double click to undo all of +it. + +It is a convenience, not a requirement — assigning the controls yourself works +just as well, and is usually what an application wants when crop state has to +persist. The ghost is the one part you cannot reproduce that way, as the function +that renders it is internal to the helper. + +**Double-click the dragon** to enter crop mode, then drag the handles or the +image itself. Double-click again to leave. + + + + + +The image starts as a 500×500 window onto a 1920×1200 photo, which is why there +is space around it — that space is where the ghost appears. + +For a side-by-side look at both control sets, see the +[cropping controls demo](/demos/cropping-controls). diff --git a/src/content/docs/docs/cropping-images/code1.js b/src/content/docs/docs/cropping-images/code1.js new file mode 100644 index 00000000..df28ae91 --- /dev/null +++ b/src/content/docs/docs/cropping-images/code1.js @@ -0,0 +1,27 @@ +const canvas = new fabric.Canvas(canvasEl, { + backgroundColor: '#f5f5f5', +}); + +// import { enterCropMode } from 'fabric/extensions'; +const { enterCropMode } = extensions; + +fabric.FabricImage.fromURL('/assets/dragon.jpg').then((image) => { + image.set({ + cropX: 710, + cropY: 350, + width: 500, + height: 500, + left: canvas.getWidth() / 2, + top: canvas.getHeight() / 2, + originX: 'center', + originY: 'center', + scaleX: 0.3, + scaleY: 0.3, + padding: 0, + }); + + image.once('mousedblclick', enterCropMode); + + canvas.add(image); + canvas.setActiveObject(image); +}); From 86b70687a3734be9f3ac92aac150c7caf8fcda14 Mon Sep 17 00:00:00 2001 From: Andrea Bogazzi Date: Thu, 30 Jul 2026 00:28:16 +0200 Subject: [PATCH 3/7] progress --- src/components/Companies/Companies.astro | 10 ---------- src/content/demo/cropping-controls/index.mdx | 14 ++------------ 2 files changed, 2 insertions(+), 22 deletions(-) diff --git a/src/components/Companies/Companies.astro b/src/components/Companies/Companies.astro index b19853c2..e25e5a85 100644 --- a/src/components/Companies/Companies.astro +++ b/src/components/Companies/Companies.astro @@ -7,16 +7,6 @@ const logos = [ description: 'Zaparoo', logo: '/logos/zaparoo.webp', }, - { - link: 'https://go.warp.dev/fabric', - description: 'Warp, built for coding with multiple AI agents', - logo: '/logos/warp.webp', - }, - { - link: 'https://netrouting.com/', - description: 'Netrouting has created an interactive web application using Fabric.js for the canvas editable objects and full-featured interface. The application is hosted on the reliable hosting infrastructure.', - logo: '/logos/netrouting-square.webp', - }, { link: 'https://automatio.ai', description: 'Automatio AI', diff --git a/src/content/demo/cropping-controls/index.mdx b/src/content/demo/cropping-controls/index.mdx index 8c19f92f..996e3de0 100644 --- a/src/content/demo/cropping-controls/index.mdx +++ b/src/content/demo/cropping-controls/index.mdx @@ -78,18 +78,8 @@ That helper swaps in `createImageCroppingControls()`, draws a ghost of the full source image so you can see what you are hiding, turns dragging into panning of the crop window, and installs another double-click handler to undo all of it. -It is a convenience for demos, not a requirement — and it is deliberately left -out above so that both control sets are live at once. Assigning the controls -yourself, as the first example does, is perfectly valid and is usually what a -real application wants: crop state that persists, entered and exited by your own -UI rather than by a double click. - -That choice is also why the first canvas shows no ghost. The translucent preview -of the hidden pixels comes from a `renderGhostImage` function that -`enterCropMode` attaches to the image as a `before:render` listener. It is an -internal of the helper and is not exported from `fabric/extensions`, so there is -currently no way to switch the ghost on for controls you assigned yourself — you -get it by going through `enterCropMode`, as below. +It is a packaged crop mode experience meant to be a baseline and an inspiration to build yours. + **Double-click the dragon** to toggle crop mode. The full source image appears at 50% opacity with a border around its real bounds, the handles become the crop From f73866b5b90bee00766e54b83185e0a7a4cada6b Mon Sep 17 00:00:00 2001 From: Andrea Bogazzi Date: Thu, 30 Jul 2026 00:36:15 +0200 Subject: [PATCH 4/7] docs(cropping): explain how enterCropMode is built MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Show the helper's own source and walk through it, since the technique is the transferable part: capture the state you are about to overwrite, swap the control set, borrow object events (`moving` for panning, `before:render` for the ghost) instead of subclassing, close over a teardown that mirrors every step, and re-arm the toggle with `once`. Add a section on recomposing the pieces. The individual action handlers (`changeCropX/Y/Width/Height`, the scale-to-cover pair) and the `withFlip` combinator are all exported, so the prepared control sets are a starting point rather than the only option — with an example building a single crop-only control. Also state which internals are still module-private (`cropPanMoveHandler`, `renderGhostImage`), which is why the ghost is only available through `enterCropMode`. Document the docs-vs-demos split in AGENTS.md: demos showcase what the library can do and keep their code minimal; guides explain how and why and are free to go deep, quoting library source when it teaches something. Co-Authored-By: Claude Opus 4.8 --- AGENTS.md | 31 +++++++ src/content/docs/docs/cropping-images.mdx | 100 +++++++++++++++++++++- 2 files changed, 128 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 32e75bf8..8ca9ee9b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -38,6 +38,37 @@ only used here to generate the API reference via TypeDoc. └── .github/workflows/ build.yml (PR check), deploy.yml (push to main → GitHub Pages) ``` +## Docs vs demos — which one to write + +The two sections have different jobs, and content written for one does not +belong in the other. + +**Demos** (`src/content/demo/`) show *what the library can do*. They are a +showcase: the visual result is the point, the code is there so a reader can +see it is achievable and poke at it. Keep the snippet as short as the effect +allows — no scaffolding, no hand-rolled reimplementations of something the +library already exports. Prose is minimal, just enough to say what to try +(what to drag, what to double-click) and what each thing on the canvas is. + +**Docs** (`src/content/docs/docs/`) explain *how it works, and why*. They are +allowed — encouraged — to go deep and get technical: quote the library's own +source when it teaches something, walk through a helper line by line, name the +internal functions involved, explain which pieces are exported and how to +recombine them, and be explicit about limitations and caveats. A guide's +interactive example should stay barebone, precisely so the surrounding prose +carries the explanation rather than the sample code. + +Practical consequences when adding content: + +- A long code listing is fine in a guide if it is *explanatory* (the + implementation of a helper being taught). It is not fine as example + scaffolding in either place. +- Explaining an extension means saying it exists, what it packages, how to + assign it, and that it is a base to build on — extensions export their + individual handlers precisely so readers can recompose them. +- Don't duplicate: a guide can link to a demo for the visual showcase, and a + demo can link to a guide for the depth. + ## Key mechanics - **Content collections** (`src/content/config.ts`): `demo` (interactive diff --git a/src/content/docs/docs/cropping-images.mdx b/src/content/docs/docs/cropping-images.mdx index 14c9a4dc..45c0dc82 100644 --- a/src/content/docs/docs/cropping-images.mdx +++ b/src/content/docs/docs/cropping-images.mdx @@ -88,8 +88,7 @@ it. It is a convenience, not a requirement — assigning the controls yourself works just as well, and is usually what an application wants when crop state has to -persist. The ghost is the one part you cannot reproduce that way, as the function -that renders it is internal to the helper. +persist. **Double-click the dragon** to enter crop mode, then drag the handles or the image itself. Double-click again to leave. @@ -101,5 +100,100 @@ image itself. Double-click again to leave. The image starts as a 500×500 window onto a 1920×1200 photo, which is why there is space around it — that space is where the ghost appears. -For a side-by-side look at both control sets, see the +## How `enterCropMode` is built + +There is nothing privileged about this helper. It is about twenty-five lines that +mix together events, controls and a closure — worth reading in full, because the +technique generalises to any interaction you want to add to Fabric.js: + +```ts +export const enterCropMode = function enterCropMode( + this: (args: TPointerEventInfo) => void, + { target }: TPointerEventInfo, +) { + const fabricImage = target as FabricImage; + const { controls, padding } = fabricImage; + fabricImage.padding = 0; + fabricImage.controls = createImageCroppingControls(); + fabricImage.on('moving', cropPanMoveHandler); + fabricImage.on('before:render', renderGhostImage); + fabricImage.setCoords(); + const exitCropMode = () => { + fabricImage.padding = padding; + fabricImage.off('moving', cropPanMoveHandler); + fabricImage.off('before:render', renderGhostImage); + fabricImage.controls = controls; + fabricImage.setCoords(); + fabricImage.once('mousedblclick', enterCropMode); + fabricImage.canvas?.requestRenderAll(); + }; + fabricImage.once('mousedblclick', exitCropMode); + fabricImage.canvas?.requestRenderAll(); +}; +``` + +Read as a recipe, it is doing five things: + +1. **Capturing the state it is about to overwrite.** `controls` and `padding` are + read into local variables before anything changes, so the exit path has + something to restore. No extra properties are stored on the image. +2. **Swapping the control set**, which changes what dragging a handle *means* + without touching the object's geometry. +3. **Borrowing object events for the rest.** `moving` is intercepted by + `cropPanMoveHandler` so dragging pans the crop window instead of moving the + object, and `before:render` lets `renderGhostImage` draw underneath the image + on every frame. Neither behaviour needed a subclass — an object event was + enough. +4. **Closing over the teardown.** `exitCropMode` is a closure holding the + original `controls` and `padding`, so it can reverse every step above. Each + `on` has a matching `off`. +5. **Re-arming itself.** The last thing `exitCropMode` does is + `once('mousedblclick', enterCropMode)`, so the two functions hand the + `mousedblclick` event back and forth. That is the whole toggle — no flag, no + state machine. + +`setCoords()` after changing `padding` and the control set keeps the cached +corner positions in sync, and `requestRenderAll()` schedules the redraw. + +Copy this shape whenever you want a temporary mode on an object: capture, swap, +subscribe, and return a closure that undoes exactly what you did. + +## Building your own + +Extensions package a generic, well-understood feature so you do not have to +write it — but they are equally meant to be read and taken apart. That is why the +individual transform handlers are exported alongside the assembled control sets: + +- `changeCropX`, `changeCropY`, `changeCropWidth`, `changeCropHeight` — one crop + edge each. +- `changeWidthAndScaleToCover`, `changeHeightAndScaleToCover` — resize the + window, then scale to keep covering it. +- `withFlip(handler, flippedHandler, axis)` — a combinator that picks between two + handlers depending on whether the target is flipped on `axis`. It is how the + built-in set keeps working on mirrored images. + +So you are never limited to the two prepared sets. Map the handlers onto +different corners, give them your own rendering, or drive one from a control that +does something else entirely: + +```js +import { Control } from 'fabric'; +import { changeCropX, changeCropWidth, withFlip } from 'fabric/extensions'; + +// a left-edge handle that only ever crops horizontally +image.controls.ml = new Control({ + x: -0.5, + y: 0, + actionHandler: withFlip(changeCropX, changeCropWidth, 'flipX'), + actionName: 'crop', +}); +``` + +A few internals are still module-private, including `cropPanMoveHandler` and +`renderGhostImage`, so the panning and the ghost cannot yet be reused outside +`enterCropMode` — which is also why the ghost only appears when you go through +that helper. The action handlers above, however, are all public and safe to +recombine. + +For a side-by-side look at both prepared control sets, see the [cropping controls demo](/demos/cropping-controls). From b44affd4f3b9396a0317d1ba68ad2dfbf5b3bdae Mon Sep 17 00:00:00 2001 From: Andrea Bogazzi Date: Thu, 30 Jul 2026 00:36:24 +0200 Subject: [PATCH 5/7] chore: bump fabric.js submodule to v7.4.0 Point the submodule at the v740 tag so the API reference is generated from the same version the site bundles (package.json is already on ^7.4.0). The previous pointer was one commit past v7.2.0, so the cropping helpers the new docs describe were missing from the generated reference. The current HEAD was an ancestor of v740, so nothing is lost. Also update the version shown by LatestRelease to match. Co-Authored-By: Claude Opus 4.8 --- fabric.js | 2 +- src/components/LatestRelease/LatestRelease.astro | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/fabric.js b/fabric.js index 22fda457..ce64f450 160000 --- a/fabric.js +++ b/fabric.js @@ -1 +1 @@ -Subproject commit 22fda4575b9a171e8efe201e21ee2bd9d77651b8 +Subproject commit ce64f450bad811750cb5a75aa749fc1502c644be diff --git a/src/components/LatestRelease/LatestRelease.astro b/src/components/LatestRelease/LatestRelease.astro index f6ed6001..1690960b 100644 --- a/src/components/LatestRelease/LatestRelease.astro +++ b/src/components/LatestRelease/LatestRelease.astro @@ -5,7 +5,7 @@ export interface Props { subtitle?: string; } const { - version = '7.0.0', + version = '7.4.0', url = 'https://github.com/fabricjs/fabric.js/releases', subtitle = 'Download latest release from GitHub', } = Astro.props as Props; From ac74579e14f202ee88a957d1d8067334072691c1 Mon Sep 17 00:00:00 2001 From: Andrea Bogazzi Date: Thu, 30 Jul 2026 00:38:50 +0200 Subject: [PATCH 6/7] chore(api): regenerate reference for v7.4.0 Output of the TypeDoc build against the v7.4.0 submodule. Most of the diff is the gitRevision embedded in every "Defined in:" source link moving from 22fda4575 to ce64f450b, alongside the 7.3/7.4 API additions. Adds pages for controlsUtils.changeHeight, changeObjectHeight, changeObjectWidth and the ControlRenderingStyleOverride type alias. Co-Authored-By: Claude Opus 4.8 --- .../docs/api/classes/ActiveSelection.md | 502 +++++------ src/content/docs/api/classes/BaseBrush.md | 30 +- .../docs/api/classes/BaseFabricObject.md | 314 +++---- src/content/docs/api/classes/Canvas.md | 353 ++++---- .../docs/api/classes/Canvas2dFilterBackend.md | 8 +- .../docs/api/classes/CanvasDOMManager.md | 20 +- src/content/docs/api/classes/Circle.md | 464 +++++----- src/content/docs/api/classes/CircleBrush.md | 36 +- .../docs/api/classes/ClipPathLayout.md | 14 +- src/content/docs/api/classes/Color.md | 50 +- src/content/docs/api/classes/Control.md | 64 +- src/content/docs/api/classes/Ellipse.md | 458 +++++----- src/content/docs/api/classes/FabricImage.md | 504 +++++------ src/content/docs/api/classes/FabricObject.md | 446 +++++----- src/content/docs/api/classes/FabricText.md | 595 ++++++------- .../docs/api/classes/FitContentLayout.md | 14 +- src/content/docs/api/classes/FixedLayout.md | 14 +- src/content/docs/api/classes/Gradient.md | 38 +- src/content/docs/api/classes/Group.md | 496 +++++------ src/content/docs/api/classes/IText.md | 767 ++++++++--------- .../api/classes/InteractiveFabricObject.md | 428 +++++----- src/content/docs/api/classes/Intersection.md | 26 +- src/content/docs/api/classes/LayoutManager.md | 18 +- .../docs/api/classes/LayoutStrategy.md | 14 +- src/content/docs/api/classes/Line.md | 458 +++++----- src/content/docs/api/classes/Observable.md | 20 +- src/content/docs/api/classes/Path.md | 464 +++++----- src/content/docs/api/classes/Pattern.md | 40 +- src/content/docs/api/classes/PatternBrush.md | 54 +- src/content/docs/api/classes/PencilBrush.md | 46 +- src/content/docs/api/classes/Point.md | 78 +- src/content/docs/api/classes/Polygon.md | 468 +++++------ src/content/docs/api/classes/Polyline.md | 468 +++++------ src/content/docs/api/classes/Rect.md | 454 +++++----- src/content/docs/api/classes/Shadow.md | 36 +- src/content/docs/api/classes/SprayBrush.md | 44 +- src/content/docs/api/classes/StaticCanvas.md | 237 +++--- .../api/classes/StaticCanvasDOMManager.md | 16 +- src/content/docs/api/classes/Textbox.md | 789 +++++++++--------- src/content/docs/api/classes/Triangle.md | 446 +++++----- .../docs/api/classes/WebGLFilterBackend.md | 46 +- .../functions/createObjectDefaultControls.md | 2 +- .../functions/createPathControls.md | 2 +- .../functions/createPolyActionHandler.md | 2 +- .../functions/createPolyControls.md | 4 +- .../functions/createPolyPositionHandler.md | 2 +- .../functions/createResizeControls.md | 2 +- .../functions/createTextboxDefaultControls.md | 2 +- .../functions/factoryPolyActionHandler.md | 2 +- .../controlsUtils/functions/getLocalPoint.md | 2 +- .../functions/polyActionHandler.md | 2 +- .../functions/renderCircleControl.md | 2 +- .../functions/renderSquareControl.md | 2 +- .../functions/wrapWithFireEvent.md | 2 +- .../functions/wrapWithFixedAnchor.md | 2 +- .../type-aliases/PathPointControlStyle.md | 8 +- .../controlsUtils/variables/changeHeight.md | 12 + .../variables/changeObjectHeight.md | 35 + .../variables/changeObjectWidth.md | 35 + .../controlsUtils/variables/changeWidth.md | 2 +- .../variables/rotationStyleHandler.md | 2 +- .../variables/rotationWithSnapping.md | 2 +- .../variables/scaleCursorStyleHandler.md | 2 +- .../variables/scaleOrSkewActionName.md | 2 +- .../variables/scaleSkewCursorStyleHandler.md | 2 +- .../controlsUtils/variables/scalingEqually.md | 4 +- .../controlsUtils/variables/scalingX.md | 4 +- .../variables/scalingXOrSkewingY.md | 2 +- .../controlsUtils/variables/scalingY.md | 4 +- .../variables/scalingYOrSkewingX.md | 2 +- .../variables/skewCursorStyleHandler.md | 2 +- .../controlsUtils/variables/skewHandlerX.md | 2 +- .../controlsUtils/variables/skewHandlerY.md | 2 +- .../namespaces/filters/classes/BaseFilter.md | 52 +- .../namespaces/filters/classes/BlendColor.md | 58 +- .../namespaces/filters/classes/BlendImage.md | 64 +- .../fabric/namespaces/filters/classes/Blur.md | 64 +- .../namespaces/filters/classes/Brightness.md | 56 +- .../namespaces/filters/classes/ColorMatrix.md | 58 +- .../namespaces/filters/classes/Composed.md | 54 +- .../namespaces/filters/classes/Contrast.md | 56 +- .../namespaces/filters/classes/Convolute.md | 58 +- .../namespaces/filters/classes/Gamma.md | 58 +- .../namespaces/filters/classes/Grayscale.md | 56 +- .../namespaces/filters/classes/HueRotation.md | 62 +- .../namespaces/filters/classes/Invert.md | 56 +- .../namespaces/filters/classes/Noise.md | 56 +- .../namespaces/filters/classes/Pixelate.md | 54 +- .../namespaces/filters/classes/RemoveColor.md | 60 +- .../namespaces/filters/classes/Resize.md | 80 +- .../namespaces/filters/classes/Saturation.md | 56 +- .../namespaces/filters/classes/Vibrance.md | 56 +- .../filters/type-aliases/TBlendMode.md | 2 +- .../filters/type-aliases/TResizeType.md | 2 +- .../filters/variables/BlackWhite.md | 2 +- .../namespaces/filters/variables/Brownie.md | 2 +- .../filters/variables/Kodachrome.md | 2 +- .../namespaces/filters/variables/Polaroid.md | 2 +- .../namespaces/filters/variables/Sepia.md | 2 +- .../filters/variables/Technicolor.md | 2 +- .../namespaces/filters/variables/Vintage.md | 2 +- .../util/functions/addTransformToObject.md | 2 +- .../namespaces/util/functions/animate.md | 6 +- .../namespaces/util/functions/animateColor.md | 2 +- .../util/functions/applyTransformToObject.md | 2 +- .../util/functions/calcAngleBetweenVectors.md | 2 +- .../util/functions/calcDimensionsMatrix.md | 2 +- .../util/functions/calcPlaneChangeMatrix.md | 2 +- .../util/functions/calcVectorRotation.md | 2 +- .../util/functions/cancelAnimFrame.md | 2 +- .../namespaces/util/functions/capValue.md | 2 +- .../util/functions/composeMatrix.md | 2 +- .../util/functions/copyCanvasElement.md | 2 +- .../fabric/namespaces/util/functions/cos.md | 2 +- .../util/functions/createCanvasElement.md | 2 +- .../namespaces/util/functions/createImage.md | 2 +- .../util/functions/createRotateMatrix.md | 2 +- .../util/functions/createScaleMatrix.md | 2 +- .../util/functions/createSkewXMatrix.md | 2 +- .../util/functions/createSkewYMatrix.md | 2 +- .../util/functions/createTranslateMatrix.md | 2 +- .../namespaces/util/functions/createVector.md | 2 +- .../namespaces/util/functions/crossProduct.md | 2 +- .../util/functions/degreesToRadians.md | 2 +- .../namespaces/util/functions/dotProduct.md | 2 +- .../util/functions/enlivenObjectEnlivables.md | 2 +- .../util/functions/enlivenObjects.md | 2 +- .../util/functions/findScaleToCover.md | 2 +- .../util/functions/findScaleToFit.md | 2 +- .../util/functions/getBoundsOfCurve.md | 2 +- .../util/functions/getOrthonormalVector.md | 2 +- .../util/functions/getPathSegmentsInfo.md | 2 +- .../util/functions/getPointOnPath.md | 2 +- .../namespaces/util/functions/getPointer.md | 2 +- .../namespaces/util/functions/getRandomInt.md | 2 +- .../util/functions/getRegularPolygonPath.md | 2 +- .../util/functions/getSmoothPathFromPoints.md | 2 +- .../util/functions/getSvgAttributes.md | 2 +- .../util/functions/getUnitVector.md | 2 +- .../util/functions/groupSVGElements.md | 2 +- .../util/functions/hasStyleChanged.md | 2 +- .../util/functions/invertTransform.md | 2 +- .../util/functions/isBetweenVectors.md | 2 +- .../util/functions/isIdentityMatrix.md | 2 +- .../namespaces/util/functions/isTouchEvent.md | 2 +- .../util/functions/isTransparent.md | 2 +- .../namespaces/util/functions/joinPath.md | 2 +- .../namespaces/util/functions/loadImage.md | 2 +- .../namespaces/util/functions/magnitude.md | 2 +- .../functions/makeBoundingBoxFromPoints.md | 2 +- .../util/functions/makePathSimpler.md | 2 +- .../namespaces/util/functions/matrixToSVG.md | 2 +- .../util/functions/mergeClipPaths.md | 4 +- .../functions/multiplyTransformMatrices.md | 2 +- .../functions/multiplyTransformMatrixArray.md | 2 +- .../namespaces/util/functions/parsePath.md | 2 +- .../parsePreserveAspectRatioAttribute.md | 2 +- .../namespaces/util/functions/parseUnit.md | 2 +- .../fabric/namespaces/util/functions/pick.md | 2 +- .../util/functions/projectStrokeOnPoints.md | 2 +- .../namespaces/util/functions/qrDecompose.md | 2 +- .../util/functions/radiansToDegrees.md | 2 +- .../util/functions/removeFromArray.md | 2 +- .../functions/removeTransformFromObject.md | 2 +- .../util/functions/requestAnimFrame.md | 2 +- .../util/functions/resetObjectTransform.md | 2 +- .../namespaces/util/functions/rotateVector.md | 2 +- .../util/functions/saveObjectTransform.md | 2 +- .../util/functions/sendObjectToPlane.md | 2 +- .../util/functions/sendPointToPlane.md | 2 +- .../util/functions/sendVectorToPlane.md | 2 +- .../fabric/namespaces/util/functions/sin.md | 2 +- .../util/functions/sizeAfterTransform.md | 2 +- .../util/functions/stylesFromArray.md | 2 +- .../util/functions/stylesToArray.md | 2 +- .../namespaces/util/functions/toBlob.md | 2 +- .../namespaces/util/functions/toDataURL.md | 2 +- .../namespaces/util/functions/toFixed.md | 2 +- .../util/functions/transformPath.md | 2 +- .../util/functions/transformPoint.md | 2 +- .../ease/variables/defaultEasing.md | 2 +- .../namespaces/ease/variables/easeInBack.md | 2 +- .../namespaces/ease/variables/easeInBounce.md | 2 +- .../namespaces/ease/variables/easeInCirc.md | 2 +- .../namespaces/ease/variables/easeInCubic.md | 2 +- .../ease/variables/easeInElastic.md | 2 +- .../namespaces/ease/variables/easeInExpo.md | 2 +- .../ease/variables/easeInOutBack.md | 2 +- .../ease/variables/easeInOutBounce.md | 2 +- .../ease/variables/easeInOutCirc.md | 2 +- .../ease/variables/easeInOutCubic.md | 2 +- .../ease/variables/easeInOutElastic.md | 2 +- .../ease/variables/easeInOutExpo.md | 2 +- .../ease/variables/easeInOutQuad.md | 2 +- .../ease/variables/easeInOutQuart.md | 2 +- .../ease/variables/easeInOutQuint.md | 2 +- .../ease/variables/easeInOutSine.md | 2 +- .../namespaces/ease/variables/easeInQuad.md | 2 +- .../namespaces/ease/variables/easeInQuart.md | 2 +- .../namespaces/ease/variables/easeInQuint.md | 2 +- .../namespaces/ease/variables/easeInSine.md | 2 +- .../namespaces/ease/variables/easeOutBack.md | 2 +- .../ease/variables/easeOutBounce.md | 2 +- .../namespaces/ease/variables/easeOutCirc.md | 2 +- .../namespaces/ease/variables/easeOutCubic.md | 2 +- .../ease/variables/easeOutElastic.md | 2 +- .../namespaces/ease/variables/easeOutExpo.md | 2 +- .../namespaces/ease/variables/easeOutQuad.md | 2 +- .../namespaces/ease/variables/easeOutQuart.md | 2 +- .../namespaces/ease/variables/easeOutQuint.md | 2 +- .../namespaces/ease/variables/easeOutSine.md | 2 +- .../namespaces/string/functions/capitalize.md | 2 +- .../namespaces/string/functions/escapeXml.md | 2 +- .../string/functions/graphemeSplit.md | 2 +- .../util/type-aliases/AnimationOptions.md | 2 +- .../util/type-aliases/AnimationState.md | 2 +- .../type-aliases/ArrayAnimationOptions.md | 2 +- .../type-aliases/ColorAnimationOptions.md | 2 +- .../util/type-aliases/EnlivenObjectOptions.md | 12 +- .../util/type-aliases/LoadImageOptions.md | 2 +- .../util/type-aliases/TAbortCallback.md | 2 +- .../util/type-aliases/TAnimation.md | 2 +- .../type-aliases/TAnimationBaseOptions.md | 10 +- .../util/type-aliases/TAnimationCallbacks.md | 10 +- .../util/type-aliases/TAnimationOptions.md | 2 +- .../type-aliases/TBaseAnimationOptions.md | 2 +- .../util/type-aliases/TComposeMatrixArgs.md | 2 +- .../util/type-aliases/TEasingFunction.md | 2 +- .../TOnAnimationChangeCallback.md | 2 +- .../TProjectStrokeOnPointsOptions.md | 20 +- .../util/type-aliases/TProjection.md | 10 +- .../util/type-aliases/TQrDecomposeOut.md | 2 +- .../util/type-aliases/TRotateMatrixArgs.md | 4 +- .../util/type-aliases/TScaleMatrixArgs.md | 14 +- .../util/type-aliases/TTranslateMatrixArgs.md | 6 +- .../util/type-aliases/TextStyleArray.md | 2 +- .../type-aliases/ValueAnimationOptions.md | 2 +- .../api/functions/createCollectionMixin.md | 2 +- src/content/docs/api/functions/getEnv.md | 2 +- .../docs/api/functions/getFabricDocument.md | 2 +- .../docs/api/functions/getFabricWindow.md | 2 +- .../docs/api/functions/getFilterBackend.md | 2 +- .../docs/api/functions/initFilterBackend.md | 2 +- .../docs/api/functions/isPutImageFaster.md | 2 +- .../api/functions/isWebGLPipelineState.md | 2 +- .../docs/api/functions/loadSVGFromString.md | 2 +- .../docs/api/functions/loadSVGFromURL.md | 2 +- .../docs/api/functions/parseSVGDocument.md | 2 +- src/content/docs/api/functions/setEnv.md | 2 +- .../docs/api/functions/setFilterBackend.md | 2 +- .../api/interfaces/ActiveSelectionOptions.md | 152 ++-- .../api/interfaces/BasicTransformEvent.md | 8 +- .../docs/api/interfaces/CanvasEvents.md | 84 +- .../docs/api/interfaces/CanvasOptions.md | 94 +-- .../docs/api/interfaces/CircleProps.md | 152 ++-- .../docs/api/interfaces/CollectionEvents.md | 6 +- .../docs/api/interfaces/DragEventData.md | 16 +- .../docs/api/interfaces/DropEventData.md | 20 +- .../docs/api/interfaces/EllipseProps.md | 148 ++-- .../docs/api/interfaces/FabricObjectProps.md | 144 ++-- .../docs/api/interfaces/GroupEvents.md | 60 +- .../docs/api/interfaces/GroupOwnProps.md | 6 +- src/content/docs/api/interfaces/GroupProps.md | 150 ++-- src/content/docs/api/interfaces/ITextProps.md | 192 +++-- src/content/docs/api/interfaces/ImageProps.md | 160 ++-- src/content/docs/api/interfaces/MiscEvents.md | 6 +- .../docs/api/interfaces/ModifiedEvent.md | 10 +- .../docs/api/interfaces/ModifyPathEvent.md | 6 +- .../docs/api/interfaces/ObjectEvents.md | 52 +- src/content/docs/api/interfaces/PathProps.md | 148 ++-- src/content/docs/api/interfaces/RectProps.md | 148 ++-- .../api/interfaces/SerializedCircleProps.md | 70 +- .../api/interfaces/SerializedEllipseProps.md | 66 +- .../api/interfaces/SerializedGroupProps.md | 70 +- .../api/interfaces/SerializedITextProps.md | 110 +-- .../api/interfaces/SerializedImageProps.md | 74 +- .../api/interfaces/SerializedLineProps.md | 70 +- .../api/interfaces/SerializedObjectProps.md | 62 +- .../api/interfaces/SerializedPathProps.md | 66 +- .../api/interfaces/SerializedPolylineProps.md | 64 +- .../api/interfaces/SerializedRectProps.md | 66 +- .../api/interfaces/SerializedTextProps.md | 106 +-- .../api/interfaces/SerializedTextboxProps.md | 114 +-- .../docs/api/interfaces/StaticCanvasEvents.md | 16 +- .../api/interfaces/StaticCanvasOptions.md | 38 +- src/content/docs/api/interfaces/TEvent.md | 4 +- .../docs/api/interfaces/TPointerEventInfo.md | 14 +- src/content/docs/api/interfaces/TextProps.md | 188 +++-- .../docs/api/interfaces/TextboxProps.md | 200 ++--- src/content/docs/api/interfaces/XY.md | 6 +- .../docs/api/type-aliases/Abortable.md | 4 +- .../api/type-aliases/CanvasPointerEvents.md | 2 +- .../docs/api/type-aliases/CircleBrushPoint.md | 10 +- .../CollectionChangeLayoutContext.md | 2 +- .../docs/api/type-aliases/ColorStop.md | 6 +- .../api/type-aliases/CommonLayoutContext.md | 10 +- .../CompleteTextStyleDeclaration.md | 2 +- .../docs/api/type-aliases/Constructor.md | 2 +- .../api/type-aliases/ControlActionHandler.md | 2 +- .../docs/api/type-aliases/ControlCallback.md | 2 +- .../api/type-aliases/ControlCursorCallback.md | 2 +- .../ControlRenderingStyleOverride.md | 10 + .../docs/api/type-aliases/CursorBoundaries.md | 10 +- .../api/type-aliases/CursorRenderingData.md | 14 +- .../docs/api/type-aliases/DrawContext.md | 2 +- .../api/type-aliases/GradientCoordValue.md | 2 +- .../docs/api/type-aliases/GradientCoords.md | 2 +- .../docs/api/type-aliases/GradientOptions.md | 18 +- .../docs/api/type-aliases/GradientType.md | 2 +- .../docs/api/type-aliases/GradientUnits.md | 2 +- .../docs/api/type-aliases/GraphemeBBox.md | 18 +- .../docs/api/type-aliases/GraphemeData.md | 6 +- .../docs/api/type-aliases/ITextEvents.md | 2 +- .../docs/api/type-aliases/ImageFormat.md | 2 +- .../docs/api/type-aliases/ImageSource.md | 2 +- .../type-aliases/ImperativeLayoutContext.md | 2 +- .../type-aliases/ImperativeLayoutOptions.md | 2 +- .../InitializationLayoutContext.md | 2 +- .../docs/api/type-aliases/IntersectionType.md | 2 +- .../docs/api/type-aliases/LayoutAfterEvent.md | 6 +- .../api/type-aliases/LayoutBeforeEvent.md | 4 +- .../docs/api/type-aliases/LayoutContext.md | 2 +- .../docs/api/type-aliases/LayoutResult.md | 10 +- .../api/type-aliases/LayoutStrategyResult.md | 10 +- .../docs/api/type-aliases/LayoutTrigger.md | 2 +- .../api/type-aliases/LinearGradientCoords.md | 18 +- .../docs/api/type-aliases/ModifierKey.md | 2 +- .../type-aliases/MultiSelectionStacking.md | 2 +- .../type-aliases/ObjectModificationEvents.md | 18 +- .../ObjectModifiedLayoutContext.md | 2 +- .../ObjectModifyingLayoutContext.md | 2 +- .../api/type-aliases/ObjectPointerEvents.md | 2 +- .../docs/api/type-aliases/PatternOptions.md | 2 +- .../docs/api/type-aliases/PatternRepeat.md | 2 +- src/content/docs/api/type-aliases/Percent.md | 2 +- .../api/type-aliases/RadialGradientCoords.md | 20 +- .../api/type-aliases/RegistrationContext.md | 6 +- .../docs/api/type-aliases/SVGElementName.md | 2 +- .../docs/api/type-aliases/SVGOptions.md | 12 +- .../type-aliases/SerializedGradientProps.md | 2 +- .../type-aliases/SerializedLayoutManager.md | 6 +- .../type-aliases/SerializedPatternOptions.md | 2 +- .../type-aliases/SerializedShadowOptions.md | 16 +- .../docs/api/type-aliases/SprayBrushPoint.md | 10 +- .../api/type-aliases/StrictLayoutContext.md | 2 +- .../docs/api/type-aliases/SupportedSVGUnit.md | 2 +- .../docs/api/type-aliases/T2DPipelineState.md | 20 +- .../docs/api/type-aliases/TArcCommand.md | 2 +- .../api/type-aliases/TArcCommandSingleFlag.md | 2 +- src/content/docs/api/type-aliases/TAxis.md | 2 +- src/content/docs/api/type-aliases/TAxisKey.md | 2 +- src/content/docs/api/type-aliases/TBBox.md | 2 +- .../docs/api/type-aliases/TBrushEventData.md | 2 +- .../type-aliases/TCacheCanvasDimensions.md | 2 +- .../api/type-aliases/TCanvasSizeOptions.md | 2 +- .../docs/api/type-aliases/TClassProperties.md | 2 +- .../api/type-aliases/TClosePathCommand.md | 2 +- .../docs/api/type-aliases/TColorArg.md | 2 +- .../api/type-aliases/TComplexParsedCommand.md | 2 +- .../type-aliases/TComplexParsedCommandType.md | 2 +- .../docs/api/type-aliases/TComplexPathData.md | 2 +- .../docs/api/type-aliases/TCornerPoint.md | 10 +- .../docs/api/type-aliases/TCrossOrigin.md | 2 +- .../api/type-aliases/TCubicCurveCommand.md | 2 +- .../TCubicCurveShortcutCommand.md | 2 +- .../docs/api/type-aliases/TCurveInfo.md | 2 +- .../docs/api/type-aliases/TDataUrlOptions.md | 2 +- src/content/docs/api/type-aliases/TDegree.md | 2 +- .../docs/api/type-aliases/TEndPathInfo.md | 2 +- .../docs/api/type-aliases/TEventsExtraData.md | 2 +- .../api/type-aliases/TFabricObjectProps.md | 2 +- src/content/docs/api/type-aliases/TFiller.md | 2 +- .../type-aliases/THorizontalLineCommand.md | 2 +- .../docs/api/type-aliases/TLineCommand.md | 2 +- src/content/docs/api/type-aliases/TMat2D.md | 2 +- .../docs/api/type-aliases/TMatColorMatrix.md | 2 +- .../api/type-aliases/TModificationEvents.md | 2 +- .../docs/api/type-aliases/TMoveToCommand.md | 2 +- .../api/type-aliases/TOptionalModifierKey.md | 2 +- src/content/docs/api/type-aliases/TOptions.md | 2 +- src/content/docs/api/type-aliases/TOriginX.md | 2 +- src/content/docs/api/type-aliases/TOriginY.md | 2 +- .../type-aliases/TParsedAbsoluteArcCommand.md | 2 +- .../TParsedAbsoluteClosePathCommand.md | 2 +- .../TParsedAbsoluteCubicCurveCommand.md | 2 +- ...ParsedAbsoluteCubicCurveShortcutCommand.md | 2 +- .../TParsedAbsoluteHorizontalLineCommand.md | 2 +- .../TParsedAbsoluteLineCommand.md | 2 +- .../TParsedAbsoluteMoveToCommand.md | 2 +- .../TParsedAbsoluteQuadraticCurveCommand.md | 2 +- ...edAbsoluteQuadraticCurveShortcutCommand.md | 2 +- .../TParsedAbsoluteVerticalLineCommand.md | 2 +- .../api/type-aliases/TParsedArcCommand.md | 2 +- .../type-aliases/TParsedClosePathCommand.md | 2 +- .../docs/api/type-aliases/TParsedCommand.md | 2 +- .../type-aliases/TParsedCubicCurveCommand.md | 2 +- .../TParsedCubicCurveShortcutCommand.md | 2 +- .../TParsedHorizontalLineCommand.md | 2 +- .../api/type-aliases/TParsedLineCommand.md | 2 +- .../api/type-aliases/TParsedMoveToCommand.md | 2 +- .../TParsedQuadraticCurveCommand.md | 2 +- .../TParsedQuadraticCurveShortcutCommand.md | 2 +- .../type-aliases/TParsedRelativeArcCommand.md | 2 +- .../TParsedRelativeClosePathCommand.md | 2 +- .../TParsedRelativeCubicCurveCommand.md | 2 +- ...ParsedRelativeCubicCurveShortcutCommand.md | 2 +- .../TParsedRelativeHorizontalLineCommand.md | 2 +- .../TParsedRelativeLineCommand.md | 2 +- .../TParsedRelativeMoveToCommand.md | 2 +- .../TParsedRelativeQuadraticCurveCommand.md | 2 +- ...edRelativeQuadraticCurveShortcutCommand.md | 2 +- .../TParsedRelativeVerticalLineCommand.md | 2 +- .../TParsedVerticalLineCommand.md | 2 +- .../docs/api/type-aliases/TPathAlign.md | 2 +- .../type-aliases/TPathSegmentCommandInfo.md | 12 +- .../docs/api/type-aliases/TPathSegmentInfo.md | 2 +- .../type-aliases/TPathSegmentInfoCommon.md | 10 +- .../docs/api/type-aliases/TPathSide.md | 2 +- .../api/type-aliases/TPipelineResources.md | 2 +- .../docs/api/type-aliases/TPointAngle.md | 2 +- .../docs/api/type-aliases/TPointerEvent.md | 2 +- .../api/type-aliases/TPointerEventNames.md | 2 +- .../docs/api/type-aliases/TProgramCache.md | 2 +- .../type-aliases/TQuadraticCurveCommand.md | 2 +- .../TQuadraticCurveShortcutCommand.md | 2 +- .../docs/api/type-aliases/TRGBAColorSource.md | 2 +- .../docs/api/type-aliases/TRGBColorSource.md | 2 +- src/content/docs/api/type-aliases/TRadian.md | 2 +- .../docs/api/type-aliases/TRectBounds.md | 2 +- .../api/type-aliases/TSVGExportOptions.md | 14 +- .../docs/api/type-aliases/TSVGReviver.md | 2 +- .../type-aliases/TSimpleParseCommandType.md | 2 +- .../api/type-aliases/TSimpleParsedCommand.md | 2 +- .../docs/api/type-aliases/TSimplePathData.md | 2 +- src/content/docs/api/type-aliases/TSize.md | 6 +- .../docs/api/type-aliases/TTextureCache.md | 2 +- .../type-aliases/TToCanvasElementOptions.md | 12 +- .../api/type-aliases/TValidToObjectMethod.md | 2 +- .../api/type-aliases/TVerticalLineCommand.md | 2 +- .../TWebGLAttributeLocationMap.md | 2 +- .../api/type-aliases/TWebGLPipelineState.md | 36 +- .../type-aliases/TWebGLProgramCacheItem.md | 8 +- .../type-aliases/TWebGLUniformLocationMap.md | 2 +- .../docs/api/type-aliases/TextStyle.md | 2 +- .../api/type-aliases/TextStyleDeclaration.md | 2 +- .../docs/api/type-aliases/Transform.md | 48 +- .../docs/api/type-aliases/TransformAction.md | 2 +- .../type-aliases/TransformActionHandler.md | 2 +- src/content/docs/api/variables/cache.md | 2 +- .../docs/api/variables/classRegistry.md | 2 +- src/content/docs/api/variables/config.md | 2 +- src/content/docs/api/variables/iMatrix.md | 2 +- .../docs/api/variables/runningAnimations.md | 2 +- src/content/docs/api/variables/version.md | 2 +- 454 files changed, 7787 insertions(+), 7558 deletions(-) create mode 100644 src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeHeight.md create mode 100644 src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeObjectHeight.md create mode 100644 src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeObjectWidth.md create mode 100644 src/content/docs/api/type-aliases/ControlRenderingStyleOverride.md diff --git a/src/content/docs/api/classes/ActiveSelection.md b/src/content/docs/api/classes/ActiveSelection.md index 5b3477d1..c4f5bbb2 100644 --- a/src/content/docs/api/classes/ActiveSelection.md +++ b/src/content/docs/api/classes/ActiveSelection.md @@ -5,7 +5,7 @@ prev: false title: "ActiveSelection" --- -Defined in: [src/shapes/ActiveSelection.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L36) +Defined in: [src/shapes/ActiveSelection.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L36) Used by Canvas to manage selection. @@ -30,7 +30,7 @@ classRegistry.setClass(MyActiveSelection) > **new ActiveSelection**(`objects`, `options`): `ActiveSelection` -Defined in: [src/shapes/ActiveSelection.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L60) +Defined in: [src/shapes/ActiveSelection.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L60) #### Parameters @@ -56,7 +56,7 @@ Defined in: [src/shapes/ActiveSelection.ts:60](https://github.com/fabricjs/fabri > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -74,7 +74,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -90,7 +90,7 @@ this takes priority over the generic control visibility > **\_objects**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] = `[]` -Defined in: [src/Collection.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L21) +Defined in: [src/Collection.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L21) #### TODO @@ -106,7 +106,7 @@ needs to end up in the constructor too > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -128,7 +128,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -153,7 +153,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -172,7 +172,7 @@ You can calculate them without updating with [()](/api/classes/activeselection/# > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -192,7 +192,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -207,7 +207,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -227,7 +227,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -245,7 +245,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -265,7 +265,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -289,7 +289,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -311,7 +311,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -330,7 +330,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -347,7 +347,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -362,7 +362,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -377,7 +377,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -397,7 +397,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -421,7 +421,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -441,7 +441,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -465,7 +465,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -495,7 +495,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -516,7 +516,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -530,7 +530,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -548,7 +548,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -569,7 +569,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -591,7 +591,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -611,7 +611,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -631,7 +631,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -645,7 +645,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -659,7 +659,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -679,7 +679,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -693,7 +693,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -713,7 +713,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -727,7 +727,7 @@ When `false`, default object's values are not included in its serialization > **interactive**: `boolean` -Defined in: [src/shapes/Group.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L106) +Defined in: [src/shapes/Group.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L106) Used to allow targeting of object inside groups. set to true if you want to select an object inside a group.\ @@ -751,7 +751,7 @@ This API is no longer supported and may be removed in a future release. > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -773,7 +773,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -788,7 +788,7 @@ part of the move action. > **layoutManager**: `ActiveSelectionLayoutManager` -Defined in: [src/shapes/ActiveSelection.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L49) +Defined in: [src/shapes/ActiveSelection.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L49) The ActiveSelection needs to use the ActiveSelectionLayoutManager or selections on interactive groups may be broken @@ -803,7 +803,7 @@ or selections on interactive groups may be broken > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -825,7 +825,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -839,7 +839,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -853,7 +853,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -867,7 +867,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -881,7 +881,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -895,7 +895,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -909,7 +909,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -923,7 +923,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -937,7 +937,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -951,7 +951,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -971,7 +971,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -991,7 +991,7 @@ null > **multiSelectionStacking**: [`MultiSelectionStacking`](/api/type-aliases/multiselectionstacking/) -Defined in: [src/shapes/ActiveSelection.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L58) +Defined in: [src/shapes/ActiveSelection.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L58) controls how selected objects are added during a multiselection event - `canvas-stacking` adds the selected object to the active selection while respecting canvas object stacking order @@ -1008,11 +1008,11 @@ meaning that the stack is ordered by the order in which objects were selected > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1032,7 +1032,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1058,7 +1058,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1075,7 +1075,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1095,7 +1095,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1111,7 +1111,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1127,7 +1127,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1141,7 +1141,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1161,7 +1161,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1175,7 +1175,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1190,7 +1190,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1204,7 +1204,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1224,7 +1224,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1244,7 +1244,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1259,7 +1259,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1278,7 +1278,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1298,7 +1298,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1318,7 +1318,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1338,7 +1338,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1352,7 +1352,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1367,7 +1367,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1388,7 +1388,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1408,7 +1408,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1428,7 +1428,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1448,7 +1448,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1462,7 +1462,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1482,7 +1482,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1515,7 +1515,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1535,7 +1535,7 @@ Width of a stroke used to render this object > **subTargetCheck**: `boolean` -Defined in: [src/shapes/Group.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L93) +Defined in: [src/shapes/Group.ts:93](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L93) Used to optimize performance set to `false` if you don't need contained objects to be targets of events @@ -1550,7 +1550,7 @@ set to `false` if you don't need contained objects to be targets of events > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1572,7 +1572,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1592,7 +1592,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1612,7 +1612,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1626,7 +1626,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1640,7 +1640,7 @@ Object width > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L234) +Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L234) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1657,7 +1657,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1671,7 +1671,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1686,7 +1686,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Record`\<`string`, `any`\> = `activeSelectionDefaultValues` -Defined in: [src/shapes/ActiveSelection.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L39) +Defined in: [src/shapes/ActiveSelection.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L39) #### Overrides @@ -1698,7 +1698,7 @@ Defined in: [src/shapes/ActiveSelection.ts:39](https://github.com/fabricjs/fabri > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1714,7 +1714,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'ActiveSelection'` -Defined in: [src/shapes/ActiveSelection.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L37) +Defined in: [src/shapes/ActiveSelection.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L37) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1741,7 +1741,7 @@ add sustainable warning message > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1764,7 +1764,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1786,7 +1786,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -1818,7 +1818,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -1848,7 +1848,7 @@ dims > **\_onObjectAdded**(`object`): `void` -Defined in: [src/shapes/Group.ts:256](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L256) +Defined in: [src/shapes/Group.ts:256](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L256) #### Parameters @@ -1870,7 +1870,7 @@ Defined in: [src/shapes/Group.ts:256](https://github.com/fabricjs/fabric.js/blob > **\_onStackOrderChanged**(): `void` -Defined in: [src/shapes/Group.ts:286](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L286) +Defined in: [src/shapes/Group.ts:286](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L286) #### Returns @@ -1886,7 +1886,7 @@ Defined in: [src/shapes/Group.ts:286](https://github.com/fabricjs/fabric.js/blob > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -1904,7 +1904,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`, `childrenOverride?`): `void` -Defined in: [src/shapes/ActiveSelection.ts:233](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L233) +Defined in: [src/shapes/ActiveSelection.ts:233](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L233) Renders controls and borders for the object @@ -1942,7 +1942,7 @@ properties to override the children overrides > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -1964,7 +1964,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -1990,7 +1990,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -2016,7 +2016,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2043,7 +2043,7 @@ Rendering canvas context > **\_toSVG**(`reviver?`): `string`[] -Defined in: [src/shapes/Group.ts:635](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L635) +Defined in: [src/shapes/Group.ts:635](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L635) Returns svg representation of an instance @@ -2071,7 +2071,7 @@ svg representation of an instance > **add**(...`objects`): `number` -Defined in: [src/shapes/Group.ts:226](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L226) +Defined in: [src/shapes/Group.ts:226](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L226) Add objects @@ -2095,7 +2095,7 @@ Add objects > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2117,7 +2117,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2164,7 +2164,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **bringObjectForward**(`object`, `intersecting?`): `boolean` -Defined in: [src/Collection.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L240) +Defined in: [src/Collection.ts:240](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L240) Moves an object or a selection up in stack of drawn objects An optional parameter, intersecting allows to move the object in front @@ -2202,7 +2202,7 @@ true if change occurred > **bringObjectToFront**(`object`): `boolean` -Defined in: [src/Collection.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L194) +Defined in: [src/Collection.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L194) Moves an object or the objects of a multiple selection to the top of the stack of drawn objects @@ -2231,7 +2231,7 @@ true if change occurred > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2250,7 +2250,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2271,7 +2271,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2292,7 +2292,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2322,7 +2322,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2348,7 +2348,7 @@ true if the object currently dragged can be dropped on the target > **canEnterGroup**(`object`): `boolean` -Defined in: [src/shapes/ActiveSelection.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L115) +Defined in: [src/shapes/ActiveSelection.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L115) block ancestors/descendants of selected objects from being selected to prevent a circular object tree @@ -2372,7 +2372,7 @@ block ancestors/descendants of selected objects from being selected to prevent a > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2408,7 +2408,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`ActiveSelection`\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2434,7 +2434,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2471,7 +2471,7 @@ fix the export type, it could not be Image but the type that getClass return for > **collectObjects**(`bbox`, `options`): [`InteractiveFabricObject`](/api/classes/interactivefabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/Collection.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L326) +Defined in: [src/Collection.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L326) Given a bounding box, return all the objects of the collection that are contained in the bounding box. If `includeIntersecting` is true, return also the objects that intersect the bounding box as well. @@ -2509,7 +2509,7 @@ array of objects contained in the bounding box, ordered from top to bottom stack > **complexity**(): `number` -Defined in: [src/Collection.ts:165](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L165) +Defined in: [src/Collection.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L165) #### Returns @@ -2527,7 +2527,7 @@ complexity > **contains**(`object`, `deep?`): `boolean` -Defined in: [src/Collection.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L148) +Defined in: [src/Collection.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L148) Returns true if collection contains an object.\ **Prefer using [FabricObject#isDescendantOf](/api/classes/fabricobject/#isdescendantof) for performance reasons** @@ -2563,7 +2563,7 @@ Object to check against > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2591,7 +2591,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Group.ts:603](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L603) +Defined in: [src/shapes/Group.ts:603](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L603) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2610,7 +2610,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2650,7 +2650,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2680,7 +2680,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2714,7 +2714,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2751,7 +2751,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2785,7 +2785,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Group.ts:494](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L494) +Defined in: [src/shapes/Group.ts:494](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L494) Execute the drawing operation for an object on a specified context @@ -2819,7 +2819,7 @@ Context to render on > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2854,7 +2854,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2886,7 +2886,7 @@ an object that represent the ancestry situation. > **findNewLowerIndex**(`object`, `idx`, `intersecting?`): `number` -Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L272) +Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L272) #### Parameters @@ -2916,7 +2916,7 @@ Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/2 > **findNewUpperIndex**(`object`, `idx`, `intersecting?`): `number` -Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L295) +Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L295) #### Parameters @@ -2946,7 +2946,7 @@ Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/2 > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2984,7 +2984,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -3011,7 +3011,7 @@ function to iterate over the controls over > **forEachObject**(`callback`): `void` -Defined in: [src/Collection.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L91) +Defined in: [src/Collection.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L91) Executes given function for each object in this group A simple shortcut for getObjects().forEach, before es6 was more complicated, @@ -3040,7 +3040,7 @@ Callback invoked with current object as first argument, > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -3068,7 +3068,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -3084,7 +3084,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -3102,7 +3102,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -3123,7 +3123,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -3139,7 +3139,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -3157,7 +3157,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -3175,7 +3175,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -3193,7 +3193,7 @@ Return the object opacity counting also the group property > **getObjects**(...`types?`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/Collection.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L108) +Defined in: [src/Collection.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L108) Returns an array of children objects of this instance @@ -3219,7 +3219,7 @@ When specified, only objects of these types are returned > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -3237,7 +3237,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/activeselection/#getpositionbyorigin) @@ -3269,7 +3269,7 @@ use [getPositionByOrigin](/api/classes/activeselection/#getpositionbyorigin) ins > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/activeselection/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -3307,7 +3307,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3325,7 +3325,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3344,7 +3344,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/activ > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3362,7 +3362,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3381,7 +3381,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/activ > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3405,7 +3405,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3429,7 +3429,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3453,7 +3453,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3477,7 +3477,7 @@ Returns filter for svg shadow > **getSvgStyles**(): `string` -Defined in: [src/shapes/Group.ts:650](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L650) +Defined in: [src/shapes/Group.ts:650](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L650) Returns styles-string for svg-export, specific version for group @@ -3495,7 +3495,7 @@ Returns styles-string for svg-export, specific version for group > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3527,7 +3527,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3545,7 +3545,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3565,7 +3565,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3583,7 +3583,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3601,7 +3601,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3619,7 +3619,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3637,7 +3637,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3665,7 +3665,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3694,7 +3694,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3723,7 +3723,7 @@ Boolean > **insertAt**(`index`, ...`objects`): `number` -Defined in: [src/shapes/Group.ts:238](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L238) +Defined in: [src/shapes/Group.ts:238](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L238) Inserts an object into collection at specified index @@ -3755,7 +3755,7 @@ Object to insert > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3783,7 +3783,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3811,7 +3811,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3841,7 +3841,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3869,7 +3869,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3897,7 +3897,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3926,7 +3926,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3951,7 +3951,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isEmpty**(): `boolean` -Defined in: [src/Collection.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L128) +Defined in: [src/Collection.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L128) Returns true if collection contains no objects @@ -3971,7 +3971,7 @@ true if collection is empty > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -4003,7 +4003,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -4021,7 +4021,7 @@ return if the object would be visible in rendering > **isOnACache**(): `boolean` -Defined in: [src/shapes/ActiveSelection.ts:223](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L223) +Defined in: [src/shapes/ActiveSelection.ts:223](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L223) Check if this group or its parent group are caching, recursively up @@ -4039,7 +4039,7 @@ Check if this group or its parent group are caching, recursively up > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -4060,7 +4060,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -4088,7 +4088,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -4108,7 +4108,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -4144,7 +4144,7 @@ A list of type strings to check against. > **item**(`index`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/Collection.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L120) +Defined in: [src/Collection.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L120) Returns object at specified index @@ -4170,7 +4170,7 @@ object at index > **moveObjectTo**(`object`, `index`): `boolean` -Defined in: [src/Collection.ts:262](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L262) +Defined in: [src/Collection.ts:262](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L262) Moves an object to specified level in stack of drawn objects @@ -4204,7 +4204,7 @@ true if change occurred > **multiSelectAdd**(...`targets`): `void` -Defined in: [src/shapes/ActiveSelection.ts:94](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L94) +Defined in: [src/shapes/ActiveSelection.ts:94](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L94) Adds objects with respect to [multiSelectionStacking](/api/classes/activeselection/#multiselectionstacking) @@ -4226,7 +4226,7 @@ object to add to selection > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -4252,7 +4252,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -4288,7 +4288,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -4324,7 +4324,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -4348,7 +4348,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -4368,7 +4368,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -4414,7 +4414,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4448,7 +4448,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4494,7 +4494,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4526,7 +4526,7 @@ once > **onDeselect**(): `boolean` -Defined in: [src/shapes/ActiveSelection.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L198) +Defined in: [src/shapes/ActiveSelection.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L198) remove all objects @@ -4544,7 +4544,7 @@ remove all objects > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4571,7 +4571,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4602,7 +4602,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4628,7 +4628,7 @@ Places the left/top corner of the object bounding box in p. > **remove**(...`objects`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/shapes/Group.ts:250](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L250) +Defined in: [src/shapes/Group.ts:250](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L250) Remove objects @@ -4654,7 +4654,7 @@ removed objects > **removeAll**(): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/shapes/Group.ts:317](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L317) +Defined in: [src/shapes/Group.ts:317](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L317) Remove all objects @@ -4674,7 +4674,7 @@ removed objects > **render**(`ctx`): `void` -Defined in: [src/shapes/Group.ts:537](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L537) +Defined in: [src/shapes/Group.ts:537](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L537) Renders instance on a given context @@ -4700,7 +4700,7 @@ context to render instance on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4726,7 +4726,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4752,7 +4752,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4779,7 +4779,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4805,7 +4805,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4831,7 +4831,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4857,7 +4857,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4883,7 +4883,7 @@ New width value > **sendObjectBackwards**(`object`, `intersecting?`): `boolean` -Defined in: [src/Collection.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L214) +Defined in: [src/Collection.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L214) Moves an object or a selection down in stack of drawn objects An optional parameter, `intersecting` allows to move the object in behind @@ -4921,7 +4921,7 @@ true if change occurred > **sendObjectToBack**(`object`): `boolean` -Defined in: [src/Collection.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L178) +Defined in: [src/Collection.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L178) Moves an object or the objects of a multiple selection to the bottom of the stack of drawn objects @@ -4950,7 +4950,7 @@ true if change occurred > **set**(`key`, `value?`): `ActiveSelection` -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4982,7 +4982,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -5009,7 +5009,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -5047,7 +5047,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Group.ts:519](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L519) +Defined in: [src/shapes/Group.ts:519](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L519) #### Returns @@ -5063,7 +5063,7 @@ Defined in: [src/shapes/Group.ts:519](https://github.com/fabricjs/fabric.js/blob > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -5084,7 +5084,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -5122,7 +5122,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -5147,7 +5147,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/actives > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/activeselection/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -5185,7 +5185,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -5210,7 +5210,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/activ > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -5234,7 +5234,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -5280,7 +5280,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -5304,7 +5304,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/ActiveSelection.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L215) +Defined in: [src/shapes/ActiveSelection.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L215) Decide if the object should cache or not. The Active selection never caches @@ -5322,7 +5322,7 @@ Decide if the object should cache or not. The Active selection never caches > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -5349,7 +5349,7 @@ true in order for the window to start a drag session > **size**(): `number` -Defined in: [src/Collection.ts:136](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L136) +Defined in: [src/Collection.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L136) Returns a size of a collection (i.e: length of an array containing its objects) @@ -5369,7 +5369,7 @@ Collection size > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -5401,7 +5401,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -5423,7 +5423,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -5451,7 +5451,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`reviver?`): `string` -Defined in: [src/shapes/Group.ts:664](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L664) +Defined in: [src/shapes/Group.ts:664](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L664) Returns svg clipPath representation of an instance @@ -5479,7 +5479,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -5507,7 +5507,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -5535,7 +5535,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `ActiveSelection` -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -5561,7 +5561,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5581,7 +5581,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & [`SerializedGroupProps`](/api/interfaces/serializedgroupprops/) -Defined in: [src/shapes/Group.ts:574](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L574) +Defined in: [src/shapes/Group.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L574) Returns object representation of an instance @@ -5619,7 +5619,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/ActiveSelection.ts:207](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L207) +Defined in: [src/shapes/ActiveSelection.ts:207](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L207) Returns string representation of a group @@ -5637,7 +5637,7 @@ Returns string representation of a group > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5669,7 +5669,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5695,7 +5695,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5717,7 +5717,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5755,7 +5755,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5805,7 +5805,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5843,7 +5843,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **triggerLayout**(`options`): `void` -Defined in: [src/shapes/Group.ts:525](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L525) +Defined in: [src/shapes/Group.ts:525](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L525) #### Parameters @@ -5865,7 +5865,7 @@ Defined in: [src/shapes/Group.ts:525](https://github.com/fabricjs/fabric.js/blob > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Group.ts:470](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L470) +Defined in: [src/shapes/Group.ts:470](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L470) Check if this object or a child object will cast a shadow @@ -5883,7 +5883,7 @@ Check if this object or a child object will cast a shadow > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5915,7 +5915,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5939,7 +5939,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/ActiveSelection.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L41) +Defined in: [src/shapes/ActiveSelection.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L41) #### Returns diff --git a/src/content/docs/api/classes/BaseBrush.md b/src/content/docs/api/classes/BaseBrush.md index 50b3852c..8defa92c 100644 --- a/src/content/docs/api/classes/BaseBrush.md +++ b/src/content/docs/api/classes/BaseBrush.md @@ -5,7 +5,7 @@ prev: false title: "BaseBrush" --- -Defined in: [src/brushes/BaseBrush.ts:10](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L10) +Defined in: [src/brushes/BaseBrush.ts:10](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L10) ## See @@ -23,7 +23,7 @@ Defined in: [src/brushes/BaseBrush.ts:10](https://github.com/fabricjs/fabric.js/ > **new BaseBrush**(`canvas`): `BaseBrush` -Defined in: [src/brushes/BaseBrush.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L68) +Defined in: [src/brushes/BaseBrush.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L68) #### Parameters @@ -41,7 +41,7 @@ Defined in: [src/brushes/BaseBrush.ts:68](https://github.com/fabricjs/fabric.js/ > **canvas**: [`Canvas`](/api/classes/canvas/) -Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L66) +Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L66) #### Todo @@ -53,7 +53,7 @@ add type > **color**: `string` = `'rgb(0, 0, 0)'` -Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L15) +Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L15) Color of a brush @@ -63,7 +63,7 @@ Color of a brush > **limitedToCanvasSize**: `boolean` = `false` -Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L61) +Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L61) When `true`, the free drawing is limited to the whiteboard size. Default to false. @@ -79,7 +79,7 @@ false > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) = `null` -Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L29) +Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L29) Shadow object representing shadow of this shape. Backwards incompatibility note: This property replaces "shadowColor" (String), "shadowOffsetX" (Number), @@ -91,7 +91,7 @@ Shadow object representing shadow of this shape. > **strokeDashArray**: `null` \| `number`[] = `null` -Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L53) +Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L53) Stroke Dash Array. @@ -101,7 +101,7 @@ Stroke Dash Array. > **strokeLineCap**: `CanvasLineCap` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L35) +Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L35) Line endings style of a brush (one of "butt", "round", "square") @@ -111,7 +111,7 @@ Line endings style of a brush (one of "butt", "round", "square") > **strokeLineJoin**: `CanvasLineJoin` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L41) +Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L41) Corner style of a brush (one of "bevel", "round", "miter") @@ -121,7 +121,7 @@ Corner style of a brush (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` = `10` -Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L47) +Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L47) Maximum miter length (used for strokeLineJoin = "miter") of a brush's @@ -131,7 +131,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of a brush's > **width**: `number` = `1` -Defined in: [src/brushes/BaseBrush.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L21) +Defined in: [src/brushes/BaseBrush.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L21) Width of a brush, has to be a Number, no string literals @@ -141,7 +141,7 @@ Width of a brush, has to be a Number, no string literals > `abstract` **\_render**(): `void` -Defined in: [src/brushes/BaseBrush.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L72) +Defined in: [src/brushes/BaseBrush.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L72) #### Returns @@ -153,7 +153,7 @@ Defined in: [src/brushes/BaseBrush.ts:72](https://github.com/fabricjs/fabric.js/ > `abstract` **onMouseDown**(`pointer`, `ev`): `void` -Defined in: [src/brushes/BaseBrush.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L73) +Defined in: [src/brushes/BaseBrush.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L73) #### Parameters @@ -175,7 +175,7 @@ Defined in: [src/brushes/BaseBrush.ts:73](https://github.com/fabricjs/fabric.js/ > `abstract` **onMouseMove**(`pointer`, `ev`): `void` -Defined in: [src/brushes/BaseBrush.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L74) +Defined in: [src/brushes/BaseBrush.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L74) #### Parameters @@ -197,7 +197,7 @@ Defined in: [src/brushes/BaseBrush.ts:74](https://github.com/fabricjs/fabric.js/ > `abstract` **onMouseUp**(`ev`): `boolean` \| `void` -Defined in: [src/brushes/BaseBrush.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L78) +Defined in: [src/brushes/BaseBrush.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L78) #### Parameters diff --git a/src/content/docs/api/classes/BaseFabricObject.md b/src/content/docs/api/classes/BaseFabricObject.md index 3029d95c..2e5ef395 100644 --- a/src/content/docs/api/classes/BaseFabricObject.md +++ b/src/content/docs/api/classes/BaseFabricObject.md @@ -5,7 +5,7 @@ prev: false title: "BaseFabricObject" --- -Defined in: [src/shapes/Object/Object.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L178) +Defined in: [src/shapes/Object/Object.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L178) Root object class from which all 2d shape classes inherit from @@ -121,7 +121,7 @@ drop > **new BaseFabricObject**\<`Props`, `SProps`, `EventSpec`\>(`options?`): `FabricObject`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Object/Object.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L370) +Defined in: [src/shapes/Object/Object.ts:370](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L370) Constructor @@ -147,7 +147,7 @@ Options object > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -172,7 +172,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -191,7 +191,7 @@ You can calculate them without updating with [()](/api/classes/basefabricobject/ > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -215,7 +215,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -230,7 +230,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -252,7 +252,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -271,7 +271,7 @@ when being scaled via the controls. > `optional` **clipPath**: `FabricObject`\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) #### Implementation of @@ -283,7 +283,7 @@ Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -300,7 +300,7 @@ true > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -318,7 +318,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) #### Implementation of @@ -330,7 +330,7 @@ Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -352,7 +352,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -376,7 +376,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -400,7 +400,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -414,7 +414,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -432,7 +432,7 @@ Object height > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -446,7 +446,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -468,7 +468,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -494,7 +494,7 @@ You can change this by setting originX > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -508,7 +508,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -528,7 +528,7 @@ Minimum allowed scale value of an object > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -554,7 +554,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -574,7 +574,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -594,7 +594,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -614,7 +614,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -628,7 +628,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -648,7 +648,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -662,7 +662,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -673,7 +673,7 @@ Used to keep the original parent ref when the object has been added to an Active > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -697,7 +697,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -721,7 +721,7 @@ Object scale factor (vertical) > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) #### Implementation of @@ -733,7 +733,7 @@ Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -757,7 +757,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -781,7 +781,7 @@ Angle of skew on y axes of an object (in degrees) > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) #### Implementation of @@ -793,7 +793,7 @@ Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -813,7 +813,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -833,7 +833,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -853,7 +853,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -867,7 +867,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -887,7 +887,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -924,7 +924,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -948,7 +948,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -974,7 +974,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -988,7 +988,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1006,7 +1006,7 @@ Object width > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L234) +Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L234) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1019,7 +1019,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1029,7 +1029,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1040,7 +1040,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`FabricObject`\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `fabricObjectDefaultValues` -Defined in: [src/shapes/Object/Object.ts:327](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L327) +Defined in: [src/shapes/Object/Object.ts:327](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L327) *** @@ -1048,7 +1048,7 @@ Defined in: [src/shapes/Object/Object.ts:327](https://github.com/fabricjs/fabric > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1060,7 +1060,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'FabricObject'` -Defined in: [src/shapes/Object/Object.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L343) +Defined in: [src/shapes/Object/Object.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L343) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1079,7 +1079,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1102,7 +1102,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1120,7 +1120,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -1148,7 +1148,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -1174,7 +1174,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -1188,7 +1188,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -1206,7 +1206,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -1228,7 +1228,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -1250,7 +1250,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -1273,7 +1273,7 @@ Rendering canvas context > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -1316,7 +1316,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -1335,7 +1335,7 @@ those never change with zoom or viewport changes. > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -1356,7 +1356,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -1386,7 +1386,7 @@ transform matrix for the object > **clone**(`propertiesToInclude?`): `Promise`\<`FabricObject`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -1408,7 +1408,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -1441,7 +1441,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1429) +Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1429) Returns complexity of an instance @@ -1457,7 +1457,7 @@ complexity of this instance (is 1 unless subclassed) > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -1485,7 +1485,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -1500,7 +1500,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -1526,7 +1526,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -1556,7 +1556,7 @@ Context to render on > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -1590,7 +1590,7 @@ additional context for rendering > **drawSelectionBackground**(`_ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:679](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L679) +Defined in: [src/shapes/Object/Object.ts:679](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L679) #### Parameters @@ -1608,7 +1608,7 @@ Defined in: [src/shapes/Object/Object.ts:679](https://github.com/fabricjs/fabric > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -1636,7 +1636,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -1674,7 +1674,7 @@ Options object > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -1702,7 +1702,7 @@ value of a property > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -1716,7 +1716,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -1737,7 +1737,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -1753,7 +1753,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -1771,7 +1771,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -1789,7 +1789,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -1803,7 +1803,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -1817,7 +1817,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/basefabricobject/#getpositionbyorigin) @@ -1849,7 +1849,7 @@ use [getPositionByOrigin](/api/classes/basefabricobject/#getpositionbyorigin) in > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/basefabricobject/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -1887,7 +1887,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -1905,7 +1905,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -1924,7 +1924,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/basef > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -1942,7 +1942,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -1961,7 +1961,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/basef > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -1985,7 +1985,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -2009,7 +2009,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -2027,7 +2027,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -2043,7 +2043,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -2061,7 +2061,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -2079,7 +2079,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -2097,7 +2097,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -2115,7 +2115,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -2139,7 +2139,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -2164,7 +2164,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -2189,7 +2189,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -2217,7 +2217,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -2245,7 +2245,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -2271,7 +2271,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -2299,7 +2299,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -2327,7 +2327,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -2348,7 +2348,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -2376,7 +2376,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -2390,7 +2390,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -2411,7 +2411,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -2439,7 +2439,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -2459,7 +2459,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -2491,7 +2491,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -2513,7 +2513,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -2549,7 +2549,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -2585,7 +2585,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -2609,7 +2609,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -2629,7 +2629,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -2675,7 +2675,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -2709,7 +2709,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -2755,7 +2755,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -2787,7 +2787,7 @@ once > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -2813,7 +2813,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -2835,7 +2835,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -2857,7 +2857,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -2879,7 +2879,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -2905,7 +2905,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -2931,7 +2931,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -2957,7 +2957,7 @@ New width value > **set**(`key`, `value?`): `FabricObject`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -2989,7 +2989,7 @@ Property value (if function, the value is passed into it and its return value is > **setCoords**(): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:449](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L449) +Defined in: [src/shapes/Object/ObjectGeometry.ts:451](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L451) Sets corner and controls position coordinates based on current angle, width and height, left and top. aCoords are used to quickly find an object on the canvas. @@ -3009,7 +3009,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -3026,7 +3026,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -3064,7 +3064,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -3089,7 +3089,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/basefab > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/basefabricobject/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -3127,7 +3127,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -3152,7 +3152,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/basef > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -3176,7 +3176,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -3222,7 +3222,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -3246,7 +3246,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -3265,7 +3265,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -3283,7 +3283,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -3307,7 +3307,7 @@ Returns DOM element with the FabricObject > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -3331,7 +3331,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -3355,7 +3355,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `FabricObject`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -3381,7 +3381,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -3397,7 +3397,7 @@ JSON > **toObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1756) +Defined in: [src/shapes/Object/Object.ts:1756](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1756) Returns an object representation of an instance @@ -3421,7 +3421,7 @@ Object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -3435,7 +3435,7 @@ Returns a string representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -3457,7 +3457,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -3479,7 +3479,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -3517,7 +3517,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -3567,7 +3567,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -3605,7 +3605,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -3624,7 +3624,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -3652,7 +3652,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **fromObject**\<`T`\>(`object`, `options?`): `Promise`\<`FabricObject`\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1931) +Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1931) #### Type Parameters @@ -3680,7 +3680,7 @@ Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabri > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Object/Object.ts:329](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L329) +Defined in: [src/shapes/Object/Object.ts:329](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L329) #### Returns diff --git a/src/content/docs/api/classes/Canvas.md b/src/content/docs/api/classes/Canvas.md index 2d817c32..680264b4 100644 --- a/src/content/docs/api/classes/Canvas.md +++ b/src/content/docs/api/classes/Canvas.md @@ -5,7 +5,7 @@ prev: false title: "Canvas" --- -Defined in: [src/canvas/Canvas.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L73) +Defined in: [src/canvas/Canvas.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L73) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/canvas/Canvas.ts:73](https://github.com/fabricjs/fabric.js/blob > **new Canvas**(`el?`, `options?`): `Canvas` -Defined in: [src/canvas/Canvas.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L123) +Defined in: [src/canvas/Canvas.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L123) #### Parameters @@ -47,7 +47,7 @@ Defined in: [src/canvas/Canvas.ts:123](https://github.com/fabricjs/fabric.js/blo > `optional` **\_activeObject**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/SelectableCanvas.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L326) +Defined in: [src/canvas/SelectableCanvas.ts:333](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L333) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [src/canvas/SelectableCanvas.ts:326](https://github.com/fabricjs/fab > **\_objects**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/canvas/SelectableCanvas.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L178) +Defined in: [src/canvas/SelectableCanvas.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L178) #### TODO @@ -75,7 +75,7 @@ needs to end up in the constructor too > **\_offset**: `object` -Defined in: [src/canvas/StaticCanvas.ts:162](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L162) +Defined in: [src/canvas/StaticCanvas.ts:166](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L166) #### left @@ -95,7 +95,7 @@ Defined in: [src/canvas/StaticCanvas.ts:162](https://github.com/fabricjs/fabric. > **allowTouchScrolling**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:126](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L126) +Defined in: [src/canvas/StaticCanvas.ts:130](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L130) #### Todo @@ -115,7 +115,7 @@ move to Canvas > **altActionKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) -Defined in: [src/canvas/SelectableCanvas.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L186) +Defined in: [src/canvas/SelectableCanvas.ts:186](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L186) Indicates which key enable alternate action on corner values: 'altKey', 'shiftKey', 'ctrlKey'. @@ -140,7 +140,7 @@ feature is disabled feature disabled. > **altSelectionKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) -Defined in: [src/canvas/SelectableCanvas.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L191) +Defined in: [src/canvas/SelectableCanvas.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L191) Indicates which key enable alternative selection in case of a target overlapping with active object and we don't want to loose the @@ -170,7 +170,7 @@ feature is disabled. > **backgroundColor**: `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/canvas/StaticCanvas.ts:101](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L101) +Defined in: [src/canvas/StaticCanvas.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L105) Background color of canvas instance. @@ -188,7 +188,7 @@ Background color of canvas instance. > `optional` **backgroundImage**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvas.ts:102](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L102) +Defined in: [src/canvas/StaticCanvas.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L106) Background image of canvas instance. since 2.4.0 image caching is active, please when putting an image as background, add to the @@ -209,7 +209,7 @@ vale. As an alternative you can disable image objectCaching > **backgroundVpt**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L100) +Defined in: [src/canvas/StaticCanvas.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L104) if set to false background image is not affected by viewport transform @@ -235,7 +235,7 @@ we should really find a different way to do this > **centeredKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) -Defined in: [src/canvas/SelectableCanvas.ts:185](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L185) +Defined in: [src/canvas/SelectableCanvas.ts:185](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L185) Indicates which key enable centered Transform values: 'altKey', 'shiftKey', 'ctrlKey'. @@ -260,7 +260,7 @@ feature is disabled feature disabled. > **centeredRotation**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:184](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L184) +Defined in: [src/canvas/SelectableCanvas.ts:184](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L184) When true, objects use center point as the origin of rotate transformation. Backwards incompatibility note: This property replaces "centerTransform" (Boolean). @@ -283,7 +283,7 @@ When true, objects use center point as the origin of rotate transformation. > **centeredScaling**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:183](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L183) +Defined in: [src/canvas/SelectableCanvas.ts:183](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L183) When true, objects use center point as the origin of scale transformation. Backwards incompatibility note: This property replaces "centerTransform" (Boolean). @@ -306,7 +306,7 @@ When true, objects use center point as the origin of scale transformation. > `optional` **clipPath**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvas.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L108) +Defined in: [src/canvas/StaticCanvas.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L112) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the canvas has rendered, and the context is placed in the @@ -327,7 +327,7 @@ clipPath will clip away controls, if you do not want this to happen use controls > **containerClass**: `string` -Defined in: [src/canvas/SelectableCanvas.ts:205](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L205) +Defined in: [src/canvas/SelectableCanvas.ts:205](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L205) Default element class that's given to wrapper (div) element of canvas @@ -349,7 +349,7 @@ customize [CanvasDOMManager](/api/classes/canvasdommanager/) instead or access [ > **controlsAboveOverlay**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L121) +Defined in: [src/canvas/StaticCanvas.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L125) #### Todo @@ -369,7 +369,7 @@ move to Canvas > **defaultCursor**: `string` -Defined in: [src/canvas/SelectableCanvas.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L201) +Defined in: [src/canvas/SelectableCanvas.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L201) Default cursor value used for the entire canvas @@ -393,7 +393,7 @@ default > `optional` **destroyed**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:153](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L153) +Defined in: [src/canvas/StaticCanvas.ts:157](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L157) If true the Canvas is in the process or has been disposed/destroyed. No more rendering operation will be executed on this canvas. @@ -408,7 +408,7 @@ No more rendering operation will be executed on this canvas. > `optional` **disposed**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:160](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L160) +Defined in: [src/canvas/StaticCanvas.ts:164](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L164) Started the process of disposing but not done yet. WIll likely complete the render cycle already scheduled but stopping adding more. @@ -423,7 +423,7 @@ WIll likely complete the render cycle already scheduled but stopping adding more > **elements**: [`CanvasDOMManager`](/api/classes/canvasdommanager/) -Defined in: [src/canvas/SelectableCanvas.ts:311](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L311) +Defined in: [src/canvas/SelectableCanvas.ts:318](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L318) #### Inherited from @@ -435,7 +435,7 @@ Defined in: [src/canvas/SelectableCanvas.ts:311](https://github.com/fabricjs/fab > **enablePointerEvents**: `boolean` -Defined in: [src/canvas/Canvas.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L81) +Defined in: [src/canvas/Canvas.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L81) When the option is enabled, PointerEvent is used instead of TPointerEvent. @@ -449,7 +449,7 @@ When the option is enabled, PointerEvent is used instead of TPointerEvent. > **enableRetinaScaling**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L115) +Defined in: [src/canvas/StaticCanvas.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L119) When true, canvas is scaled by devicePixelRatio for better rendering on retina screens @@ -467,7 +467,7 @@ When true, canvas is scaled by devicePixelRatio for better rendering on retina s > **fireMiddleClick**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:226](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L226) +Defined in: [src/canvas/SelectableCanvas.ts:226](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L226) Indicates if the canvas can fire middle click events The default value changed from false to true in Fabric 7.0 @@ -498,7 +498,7 @@ https://fabricjs.com/docs/upgrading/upgrading-to-fabric-70/ > **fireRightClick**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L225) +Defined in: [src/canvas/SelectableCanvas.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L225) Indicates if the canvas can fire right click events The default value changed from false to true in Fabric 7.0 @@ -529,7 +529,7 @@ https://fabricjs.com/docs/upgrading/upgrading-to-fabric-70/ > `optional` **freeDrawingBrush**: [`BaseBrush`](/api/classes/basebrush/) -Defined in: [src/canvas/SelectableCanvas.ts:325](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L325) +Defined in: [src/canvas/SelectableCanvas.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L332) #### Inherited from @@ -541,7 +541,7 @@ Defined in: [src/canvas/SelectableCanvas.ts:325](https://github.com/fabricjs/fab > **freeDrawingCursor**: `string` -Defined in: [src/canvas/SelectableCanvas.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L202) +Defined in: [src/canvas/SelectableCanvas.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L202) Cursor value used during free drawing @@ -565,7 +565,7 @@ crosshair > **height**: `number` -Defined in: [src/canvas/StaticCanvas.ts:97](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L97) +Defined in: [src/canvas/StaticCanvas.ts:101](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L101) Height in virtual/logical pixels of the canvas. The canvas can be taller than width if retina scaling is active @@ -584,7 +584,7 @@ The canvas can be taller than width if retina scaling is active > **hoverCursor**: `string` -Defined in: [src/canvas/SelectableCanvas.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L199) +Defined in: [src/canvas/SelectableCanvas.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L199) Default cursor value used when hovering over an object on canvas @@ -608,7 +608,7 @@ move > **imageSmoothingEnabled**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L116) +Defined in: [src/canvas/StaticCanvas.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L120) Indicates whether this canvas will use image smoothing, this is on by default in browsers @@ -626,7 +626,7 @@ Indicates whether this canvas will use image smoothing, this is on by default in > **includeDefaultValues**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L110) +Defined in: [src/canvas/StaticCanvas.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L114) Indicates whether toObject/toDatalessObject should include default values if set to false, takes precedence over the object value. @@ -645,7 +645,7 @@ if set to false, takes precedence over the object value. > **isDrawingMode**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:219](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L219) +Defined in: [src/canvas/SelectableCanvas.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L219) When true, mouse events on canvas (mousedown/mousemove/mouseup) result in free drawing. After mousedown, mousemove creates a shape, @@ -665,7 +665,7 @@ and then mouseup finalizes it and adds an instance of `fabric.Path` onto canvas. > **moveCursor**: `string` -Defined in: [src/canvas/SelectableCanvas.ts:200](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L200) +Defined in: [src/canvas/SelectableCanvas.ts:200](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L200) Default cursor value used when moving an object on canvas @@ -689,7 +689,7 @@ move > **notAllowedCursor**: `string` -Defined in: [src/canvas/SelectableCanvas.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L203) +Defined in: [src/canvas/SelectableCanvas.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L203) Cursor value used for disabled elements ( corners with disabled action ) @@ -717,7 +717,7 @@ not-allowed > **overlayColor**: `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/canvas/StaticCanvas.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L105) +Defined in: [src/canvas/StaticCanvas.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L109) Overlay color of canvas instance. @@ -739,7 +739,7 @@ Overlay color of canvas instance. > `optional` **overlayImage**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvas.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L106) +Defined in: [src/canvas/StaticCanvas.ts:110](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L110) Overlay image of canvas instance. since 2.4.0 image caching is active, please when putting an image as overlay, add to the @@ -760,7 +760,7 @@ vale. As an alternative you can disable image objectCaching > **overlayVpt**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L104) +Defined in: [src/canvas/StaticCanvas.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L108) if set to false overlay image is not affected by viewport transform @@ -786,7 +786,7 @@ we should really find a different way to do this > **patternQuality**: `PatternQuality` -Defined in: [src/canvas/StaticCanvas.ts:181](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L181) +Defined in: [src/canvas/StaticCanvas.ts:185](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L185) Controls the rendering of images under node-canvas. Has no effects on the browser context. @@ -801,7 +801,7 @@ Has no effects on the browser context. > **perPixelTargetFind**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L208) +Defined in: [src/canvas/SelectableCanvas.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L208) When true, object detection happens on per-pixel basis rather than on per-bounding-box @@ -819,7 +819,7 @@ When true, object detection happens on per-pixel basis rather than on per-boundi > **preserveObjectStacking**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:221](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L221) +Defined in: [src/canvas/SelectableCanvas.ts:221](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L221) Indicates whether objects should remain in current stack position when selected. When false objects are brought to top and rendered as part of the selection group @@ -844,7 +844,7 @@ true > **renderOnAddRemove**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L113) +Defined in: [src/canvas/StaticCanvas.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L117) Indicates whether [StaticCanvas#add](/api/classes/staticcanvas/#add), [StaticCanvas#insertAt](/api/classes/staticcanvas/#insertat) and StaticCanvas#remove, StaticCanvas#moveTo, [StaticCanvas#clear](/api/classes/staticcanvas/#clear) and many more, should also re-render canvas. @@ -867,7 +867,7 @@ Left default to true to do not break documentation and old app, fiddles. > **selection**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L189) +Defined in: [src/canvas/SelectableCanvas.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L189) Indicates whether group selection should be enabled @@ -885,7 +885,7 @@ Indicates whether group selection should be enabled > **selectionBorderColor**: `string` -Defined in: [src/canvas/SelectableCanvas.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L194) +Defined in: [src/canvas/SelectableCanvas.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L194) Color of the border of selection (usually slightly darker than color of selection itself) @@ -903,7 +903,7 @@ Color of the border of selection (usually slightly darker than color of selectio > **selectionColor**: `string` -Defined in: [src/canvas/SelectableCanvas.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L192) +Defined in: [src/canvas/SelectableCanvas.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L192) Color of selection @@ -921,7 +921,7 @@ Color of selection > **selectionDashArray**: `number`[] -Defined in: [src/canvas/SelectableCanvas.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L193) +Defined in: [src/canvas/SelectableCanvas.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L193) Default dash array pattern If not empty the selection border is dashed @@ -940,7 +940,7 @@ If not empty the selection border is dashed > **selectionFullyContained**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L196) +Defined in: [src/canvas/SelectableCanvas.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L196) Select only shapes that are fully contained in the dragged selection rectangle. @@ -958,7 +958,7 @@ Select only shapes that are fully contained in the dragged selection rectangle. > **selectionKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) \| (`"altKey"` \| `"ctrlKey"` \| `"metaKey"` \| `"shiftKey"`)[] -Defined in: [src/canvas/SelectableCanvas.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L190) +Defined in: [src/canvas/SelectableCanvas.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L190) Indicates which key or keys enable multiple click selection Pass value as a string or array of strings @@ -984,7 +984,7 @@ feature is disabled. > **selectionLineWidth**: `number` -Defined in: [src/canvas/SelectableCanvas.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L195) +Defined in: [src/canvas/SelectableCanvas.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L195) Width of a line used in object/group selection @@ -1002,7 +1002,7 @@ Width of a line used in object/group selection > **skipOffscreen**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L114) +Defined in: [src/canvas/StaticCanvas.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L118) Based on vptCoords and object.aCoords, skip rendering of objects that are not included in current viewport. @@ -1030,7 +1030,7 @@ true > **skipTargetFind**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:210](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L210) +Defined in: [src/canvas/SelectableCanvas.ts:210](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L210) When true, target detection is skipped. Target detection will return always undefined. click selection won't work anymore, events will fire with no targets. @@ -1052,7 +1052,7 @@ if you deactivate both, you should look into staticCanvas. > **stopContextMenu**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:224](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L224) +Defined in: [src/canvas/SelectableCanvas.ts:224](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L224) Indicates if the right click on canvas can output the context menu or not The default value changed from false to true in Fabric 7.0 @@ -1083,7 +1083,7 @@ https://fabricjs.com/docs/upgrading/upgrading-to-fabric-70/ > **svgViewportTransformation**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:909](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L909) +Defined in: [src/canvas/StaticCanvas.ts:913](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L913) When true, getSvgTransform() will apply the StaticCanvas.viewportTransform to the SVG transformation. When true, a zoomed canvas will then produce zoomed SVG output. @@ -1102,7 +1102,7 @@ a zoomed canvas will then produce zoomed SVG output. > **targetFindTolerance**: `number` -Defined in: [src/canvas/SelectableCanvas.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L209) +Defined in: [src/canvas/SelectableCanvas.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L209) Number of pixels around target pixel to tolerate (consider active) during object detection @@ -1120,7 +1120,7 @@ Number of pixels around target pixel to tolerate (consider active) during object > **textEditingManager**: `TextEditingManager` -Defined in: [src/canvas/Canvas.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L121) +Defined in: [src/canvas/Canvas.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L121) *** @@ -1128,7 +1128,7 @@ Defined in: [src/canvas/Canvas.ts:121](https://github.com/fabricjs/fabric.js/blo > **uniformScaling**: `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:181](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L181) +Defined in: [src/canvas/SelectableCanvas.ts:181](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L181) When true, objects can be transformed by one side (unproportionately) when dragged on the corners that normally would not do that. @@ -1151,7 +1151,7 @@ fabric 4.0 // changed name and default value > **uniScaleKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) -Defined in: [src/canvas/SelectableCanvas.ts:182](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L182) +Defined in: [src/canvas/SelectableCanvas.ts:182](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L182) Indicates which key switches uniform scaling. values: 'altKey', 'shiftKey', 'ctrlKey'. @@ -1179,7 +1179,7 @@ and viceversa. > **viewportTransform**: [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/canvas/StaticCanvas.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L128) +Defined in: [src/canvas/StaticCanvas.ts:132](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L132) The transformation (a Canvas 2D API transform matrix) which focuses the viewport @@ -1207,7 +1207,7 @@ canvas.viewportTransform = [0.7, 0, 0, 0.7, 50, 50]; > **vptCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/canvas/StaticCanvas.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L133) +Defined in: [src/canvas/StaticCanvas.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L137) The viewport bounding box in scene plane coordinates, see [calcViewportBoundaries](/api/classes/canvas/#calcviewportboundaries) @@ -1221,7 +1221,7 @@ The viewport bounding box in scene plane coordinates, see [calcViewportBoundarie > **width**: `number` -Defined in: [src/canvas/StaticCanvas.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L96) +Defined in: [src/canvas/StaticCanvas.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L100) Width in virtual/logical pixels of the canvas. The canvas can be larger than width if retina scaling is active @@ -1240,7 +1240,7 @@ The canvas can be larger than width if retina scaling is active > `static` **ownDefaults**: [`TOptions`](/api/type-aliases/toptions/)\<[`CanvasOptions`](/api/interfaces/canvasoptions/)\> = `canvasDefaults` -Defined in: [src/canvas/SelectableCanvas.ts:305](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L305) +Defined in: [src/canvas/SelectableCanvas.ts:312](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L312) #### Inherited from @@ -1254,7 +1254,7 @@ Defined in: [src/canvas/SelectableCanvas.ts:305](https://github.com/fabricjs/fab > **get** **contextContainer**(): `CanvasRenderingContext2D` -Defined in: [src/canvas/StaticCanvas.ts:144](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L144) +Defined in: [src/canvas/StaticCanvas.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L148) ##### Returns @@ -1272,7 +1272,7 @@ Defined in: [src/canvas/StaticCanvas.ts:144](https://github.com/fabricjs/fabric. > **get** **contextTop**(): `CanvasRenderingContext2D` -Defined in: [src/canvas/SelectableCanvas.ts:315](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L315) +Defined in: [src/canvas/SelectableCanvas.ts:322](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L322) ##### Returns @@ -1290,7 +1290,7 @@ Defined in: [src/canvas/SelectableCanvas.ts:315](https://github.com/fabricjs/fab > **get** **lowerCanvasEl**(): `HTMLCanvasElement` -Defined in: [src/canvas/StaticCanvas.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L140) +Defined in: [src/canvas/StaticCanvas.ts:144](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L144) A reference to the canvas actual HTMLCanvasElement. Can be use to read the raw pixels, but never write or manipulate @@ -1311,7 +1311,7 @@ Can be use to read the raw pixels, but never write or manipulate > **get** **upperCanvasEl**(): `HTMLCanvasElement` -Defined in: [src/canvas/SelectableCanvas.ts:312](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L312) +Defined in: [src/canvas/SelectableCanvas.ts:319](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L319) ##### Returns @@ -1329,7 +1329,7 @@ Defined in: [src/canvas/SelectableCanvas.ts:312](https://github.com/fabricjs/fab > **get** **wrapperEl**(): `HTMLDivElement` -Defined in: [src/canvas/SelectableCanvas.ts:318](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L318) +Defined in: [src/canvas/SelectableCanvas.ts:325](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L325) ##### Returns @@ -1345,7 +1345,7 @@ Defined in: [src/canvas/SelectableCanvas.ts:318](https://github.com/fabricjs/fab > **\_basicEventHandler**\<`T`\>(`eventType`, `options`): [`CanvasEvents`](/api/interfaces/canvasevents/) & [`ObjectEvents`](/api/interfaces/objectevents/)\[`T`\] -Defined in: [src/canvas/Canvas.ts:923](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L923) +Defined in: [src/canvas/Canvas.ts:923](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L923) #### Type Parameters @@ -1373,7 +1373,7 @@ Defined in: [src/canvas/Canvas.ts:923](https://github.com/fabricjs/fabric.js/blo > **\_chooseObjectsToRender**(): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/canvas/SelectableCanvas.ts:377](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L377) +Defined in: [src/canvas/SelectableCanvas.ts:384](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L384) Divides objects in two groups, one to render immediately and one to render as activeGroup. @@ -1394,7 +1394,7 @@ objects to render immediately and pushes the other in the activeGroup. > **\_discardActiveObject**(`e?`, `object?`): `this is { _activeObject: undefined }` -Defined in: [src/canvas/SelectableCanvas.ts:1273](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1273) +Defined in: [src/canvas/SelectableCanvas.ts:1285](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1285) This is supposed to be equivalent to discardActiveObject but without firing any selection events ( can still fire object transformation events ). There is commitment to have this stay this way. @@ -1430,7 +1430,7 @@ true if the active object has been discarded > **\_onStackOrderChanged**(): `void` -Defined in: [src/canvas/SelectableCanvas.ts:367](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L367) +Defined in: [src/canvas/SelectableCanvas.ts:374](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L374) #### Returns @@ -1446,7 +1446,7 @@ Defined in: [src/canvas/SelectableCanvas.ts:367](https://github.com/fabricjs/fab > **\_set**(`key`, `value`): `void` -Defined in: [src/CommonMethods.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L38) +Defined in: [src/CommonMethods.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L38) #### Parameters @@ -1472,7 +1472,7 @@ Defined in: [src/CommonMethods.ts:38](https://github.com/fabricjs/fabric.js/blob > **\_setActiveObject**(`object`, `e?`): `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:1241](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1241) +Defined in: [src/canvas/SelectableCanvas.ts:1253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1253) This is supposed to be equivalent to setActiveObject but without firing any event. There is commitment to have this stay this way. @@ -1508,7 +1508,7 @@ true if the object has been selected > **\_setCursorFromEvent**(`e`, `target?`): `void` -Defined in: [src/canvas/Canvas.ts:1376](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L1376) +Defined in: [src/canvas/Canvas.ts:1400](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L1400) Sets the cursor depending on where the canvas is being hovered. Note: very buggy in Opera @@ -1537,7 +1537,7 @@ Object that the mouse is hovering, if so. > **absolutePan**(`point`): `void` -Defined in: [src/canvas/StaticCanvas.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L400) +Defined in: [src/canvas/StaticCanvas.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L404) Pan viewport so as to place point at top left corner of canvas @@ -1563,7 +1563,7 @@ to move to > **add**(...`objects`): `number` -Defined in: [src/canvas/StaticCanvas.ts:219](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L219) +Defined in: [src/canvas/StaticCanvas.ts:223](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L223) Adds objects to collection Objects should be instances of (or inherit from) FabricObject @@ -1592,7 +1592,7 @@ new array length > **addOrRemove**(`functor`, `forTouch`): `void` -Defined in: [src/canvas/Canvas.ts:168](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L168) +Defined in: [src/canvas/Canvas.ts:168](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L168) #### Parameters @@ -1614,7 +1614,7 @@ Defined in: [src/canvas/Canvas.ts:168](https://github.com/fabricjs/fabric.js/blo > **bringObjectForward**(`object`, `intersecting?`): `boolean` -Defined in: [src/Collection.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L240) +Defined in: [src/Collection.ts:240](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L240) Moves an object or a selection up in stack of drawn objects An optional parameter, intersecting allows to move the object in front @@ -1652,7 +1652,7 @@ true if change occurred > **bringObjectToFront**(`object`): `boolean` -Defined in: [src/Collection.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L194) +Defined in: [src/Collection.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L194) Moves an object or the objects of a multiple selection to the top of the stack of drawn objects @@ -1681,7 +1681,7 @@ true if change occurred > **calcOffset**(): `object` -Defined in: [src/canvas/StaticCanvas.ts:275](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L275) +Defined in: [src/canvas/StaticCanvas.ts:279](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L279) Calculates canvas element offset relative to the document This method is also attached as "resize" event handler of window @@ -1708,7 +1708,7 @@ This method is also attached as "resize" event handler of window > **calcViewportBoundaries**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/canvas/StaticCanvas.ts:497](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L497) +Defined in: [src/canvas/StaticCanvas.ts:501](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L501) Calculate the position of the 4 corner of canvas with current viewportTransform. helps to determinate when an object is in the current rendering viewport @@ -1727,7 +1727,7 @@ helps to determinate when an object is in the current rendering viewport > **cancelRequestedRender**(): `void` -Defined in: [src/canvas/StaticCanvas.ts:515](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L515) +Defined in: [src/canvas/StaticCanvas.ts:519](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L519) #### Returns @@ -1743,7 +1743,7 @@ Defined in: [src/canvas/StaticCanvas.ts:515](https://github.com/fabricjs/fabric. > **centerObject**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L712) +Defined in: [src/canvas/StaticCanvas.ts:716](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L716) Centers object vertically and horizontally in the canvas @@ -1769,7 +1769,7 @@ Object to center vertically and horizontally > **centerObjectH**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:690](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L690) +Defined in: [src/canvas/StaticCanvas.ts:694](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L694) Centers object horizontally in the canvas @@ -1793,7 +1793,7 @@ Centers object horizontally in the canvas > **centerObjectV**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L701) +Defined in: [src/canvas/StaticCanvas.ts:705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L705) Centers object vertically in the canvas @@ -1819,7 +1819,7 @@ Object to center vertically > **clear**(): `void` -Defined in: [src/canvas/Canvas.ts:1594](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L1594) +Defined in: [src/canvas/Canvas.ts:1618](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L1618) clear [textEditingManager](/api/classes/canvas/#texteditingmanager) @@ -1837,7 +1837,7 @@ clear [textEditingManager](/api/classes/canvas/#texteditingmanager) > **clearContext**(`ctx`): `void` -Defined in: [src/canvas/StaticCanvas.ts:432](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L432) +Defined in: [src/canvas/StaticCanvas.ts:436](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L436) Clears specified context of canvas element @@ -1863,7 +1863,7 @@ Context to clear > **clone**(`properties?`): `Promise`\<`Canvas`\> -Defined in: [src/canvas/StaticCanvas.ts:1278](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1278) +Defined in: [src/canvas/StaticCanvas.ts:1287](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1287) Clones canvas instance @@ -1889,7 +1889,7 @@ Array of properties to include in the cloned canvas and children > **cloneWithoutData**(): `Canvas` -Defined in: [src/canvas/StaticCanvas.ts:1288](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1288) +Defined in: [src/canvas/StaticCanvas.ts:1297](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1297) Clones canvas instance without cloning existing data. This essentially copies canvas dimensions since loadFromJSON does not affect canvas size. @@ -1908,7 +1908,7 @@ This essentially copies canvas dimensions since loadFromJSON does not affect can > **collectObjects**(`bbox`, `options`): [`InteractiveFabricObject`](/api/classes/interactivefabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/Collection.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L326) +Defined in: [src/Collection.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L326) Given a bounding box, return all the objects of the collection that are contained in the bounding box. If `includeIntersecting` is true, return also the objects that intersect the bounding box as well. @@ -1946,7 +1946,7 @@ array of objects contained in the bounding box, ordered from top to bottom stack > **complexity**(): `number` -Defined in: [src/Collection.ts:165](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L165) +Defined in: [src/Collection.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L165) Returns number representation of a collection complexity @@ -1966,7 +1966,7 @@ complexity > **contains**(`object`, `deep?`): `boolean` -Defined in: [src/Collection.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L148) +Defined in: [src/Collection.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L148) Returns true if collection contains an object.\ **Prefer using [FabricObject#isDescendantOf](/api/classes/fabricobject/#isdescendantof) for performance reasons** @@ -2002,7 +2002,7 @@ Object to check against > **createSVGClipPathMarkup**(`options`): `string` -Defined in: [src/canvas/StaticCanvas.ts:1036](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1036) +Defined in: [src/canvas/StaticCanvas.ts:1040](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1040) #### Parameters @@ -2024,7 +2024,7 @@ Defined in: [src/canvas/StaticCanvas.ts:1036](https://github.com/fabricjs/fabric > **createSVGFontFacesMarkup**(): `string` -Defined in: [src/canvas/StaticCanvas.ts:1079](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1079) +Defined in: [src/canvas/StaticCanvas.ts:1083](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1083) Creates markup containing SVG font faces, font URLs for font faces must be collected by developers @@ -2044,7 +2044,7 @@ and are not extracted from the DOM by fabricjs > **createSVGRefElementsMarkup**(): `string` -Defined in: [src/canvas/StaticCanvas.ts:1051](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1051) +Defined in: [src/canvas/StaticCanvas.ts:1055](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1055) Creates markup containing SVG referenced elements like patterns, gradients etc. @@ -2062,7 +2062,7 @@ Creates markup containing SVG referenced elements like patterns, gradients etc. > **destroy**(): `void` -Defined in: [src/canvas/Canvas.ts:1602](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L1602) +Defined in: [src/canvas/Canvas.ts:1626](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L1626) clear [textEditingManager](/api/classes/canvas/#texteditingmanager) @@ -2080,7 +2080,7 @@ clear [textEditingManager](/api/classes/canvas/#texteditingmanager) > **discardActiveObject**(`e?`): `this is { _activeObject: undefined }` -Defined in: [src/canvas/SelectableCanvas.ts:1303](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1303) +Defined in: [src/canvas/SelectableCanvas.ts:1315](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1315) Discards currently active object and fire events. If the function is called by fabric as a consequence of a mouse event, the event is passed as a parameter and @@ -2109,7 +2109,7 @@ true if the active object has been discarded > **dispose**(): `Promise`\<`boolean`\> -Defined in: [src/canvas/StaticCanvas.ts:1422](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1422) +Defined in: [src/canvas/StaticCanvas.ts:1431](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1431) Waits until rendering has settled to destroy the canvas @@ -2133,7 +2133,7 @@ if aborted by a consequent call > **drawClipPathOnCanvas**(`ctx`, `clipPath`): `void` -Defined in: [src/canvas/StaticCanvas.ts:579](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L579) +Defined in: [src/canvas/StaticCanvas.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L583) Paint the cached clipPath on the lowerCanvasEl @@ -2163,7 +2163,7 @@ Context to render on > **drawControls**(`ctx`): `void` -Defined in: [src/canvas/SelectableCanvas.ts:1411](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1411) +Defined in: [src/canvas/SelectableCanvas.ts:1423](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1423) Draws objects' controls (borders/controls) @@ -2189,7 +2189,7 @@ Context to render controls on > **endCurrentTransform**(`e?`): `void` -Defined in: [src/canvas/SelectableCanvas.ts:1323](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1323) +Defined in: [src/canvas/SelectableCanvas.ts:1335](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1335) End the current transform. You don't usually need to call this method unless you are interrupting a user initiated transform @@ -2217,7 +2217,7 @@ send the mouse event that generate the finalize down, so it can be used in the e > **findNewLowerIndex**(`object`, `idx`, `intersecting?`): `number` -Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L272) +Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L272) #### Parameters @@ -2247,7 +2247,7 @@ Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/2 > **findNewUpperIndex**(`object`, `idx`, `intersecting?`): `number` -Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L295) +Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L295) #### Parameters @@ -2277,7 +2277,7 @@ Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/2 > **findTarget**(`e`): `FullTargetsInfoWithContainer` -Defined in: [src/canvas/SelectableCanvas.ts:753](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L753) +Defined in: [src/canvas/SelectableCanvas.ts:760](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L760) This function is in charge of deciding which is the object that is the current target of an interaction event. For interaction event we mean a pointer related action on the canvas. @@ -2309,7 +2309,7 @@ the target found > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2347,7 +2347,7 @@ Options object > **fireEventFromPointerEvent**(`e`, `eventName`, `secondaryName`, `extraData`): `void` -Defined in: [src/canvas/Canvas.ts:549](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L549) +Defined in: [src/canvas/Canvas.ts:549](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L549) This supports gesture event firing It is a method to keep some code organized, it exposes private methods @@ -2382,7 +2382,7 @@ keyof [`ObjectEvents`](/api/interfaces/objectevents/) > **forEachObject**(`callback`): `void` -Defined in: [src/Collection.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L91) +Defined in: [src/Collection.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L91) Executes given function for each object in this group A simple shortcut for getObjects().forEach, before es6 was more complicated, @@ -2411,7 +2411,7 @@ Callback invoked with current object as first argument, > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2439,7 +2439,7 @@ value of a property > **getActiveObject**(): `undefined` \| [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/SelectableCanvas.ts:1143](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1143) +Defined in: [src/canvas/SelectableCanvas.ts:1155](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1155) Returns currently active object @@ -2459,7 +2459,7 @@ active object > **getActiveObjects**(): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/canvas/SelectableCanvas.ts:1151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1151) +Defined in: [src/canvas/SelectableCanvas.ts:1163](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1163) Returns an array with the current selected objects @@ -2479,7 +2479,7 @@ active objects array > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/canvas/StaticCanvas.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L683) +Defined in: [src/canvas/StaticCanvas.ts:687](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L687) Returns coordinates of a center of canvas. @@ -2497,7 +2497,7 @@ Returns coordinates of a center of canvas. > **getContext**(): `CanvasRenderingContext2D` -Defined in: [src/canvas/StaticCanvas.ts:440](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L440) +Defined in: [src/canvas/StaticCanvas.ts:444](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L444) Returns context of canvas where objects are drawn @@ -2515,7 +2515,7 @@ Returns context of canvas where objects are drawn > **getElement**(): `HTMLCanvasElement` -Defined in: [src/canvas/StaticCanvas.ts:424](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L424) +Defined in: [src/canvas/StaticCanvas.ts:428](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L428) Returns <canvas> element corresponding to this instance @@ -2533,7 +2533,7 @@ Returns <canvas> element corresponding to this instance > **getHeight**(): `number` -Defined in: [src/canvas/StaticCanvas.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L291) +Defined in: [src/canvas/StaticCanvas.ts:295](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L295) Returns canvas height (in px) @@ -2551,7 +2551,7 @@ Returns canvas height (in px) > **getObjects**(...`types?`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/Collection.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L108) +Defined in: [src/Collection.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L108) Returns an array of children objects of this instance @@ -2577,7 +2577,7 @@ When specified, only objects of these types are returned > **getScenePoint**(`e`): [`Point`](/api/classes/point/) -Defined in: [src/canvas/SelectableCanvas.ts:1032](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1032) +Defined in: [src/canvas/SelectableCanvas.ts:1044](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1044) #### Parameters @@ -2612,7 +2612,7 @@ const viewportPoint = sendPointToPlane( > **getSelectionContext**(): `CanvasRenderingContext2D` -Defined in: [src/canvas/SelectableCanvas.ts:1127](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1127) +Defined in: [src/canvas/SelectableCanvas.ts:1139](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1139) Returns context of canvas where object selection is drawn @@ -2632,7 +2632,7 @@ Returns context of canvas where object selection is drawn > **getSelectionElement**(): `HTMLCanvasElement` -Defined in: [src/canvas/SelectableCanvas.ts:1135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1135) +Defined in: [src/canvas/SelectableCanvas.ts:1147](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1147) Returns <canvas> element on which object selection is drawn @@ -2650,7 +2650,7 @@ Returns <canvas> element on which object selection is drawn > **getTopContext**(): `CanvasRenderingContext2D` -Defined in: [src/canvas/SelectableCanvas.ts:1118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1118) +Defined in: [src/canvas/SelectableCanvas.ts:1130](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1130) Returns context of top canvas where interactions are drawn @@ -2668,7 +2668,7 @@ Returns context of top canvas where interactions are drawn > **getViewportPoint**(`e`): [`Point`](/api/classes/point/) -Defined in: [src/canvas/SelectableCanvas.ts:1013](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1013) +Defined in: [src/canvas/SelectableCanvas.ts:1025](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1025) #### Parameters @@ -2705,7 +2705,7 @@ const scenePoint = sendPointToPlane( > **getVpCenter**(): [`Point`](/api/classes/point/) -Defined in: [src/canvas/StaticCanvas.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L750) +Defined in: [src/canvas/StaticCanvas.ts:754](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L754) Calculate the point in canvas that correspond to the center of actual viewport. @@ -2725,7 +2725,7 @@ vpCenter, viewport center > **getWidth**(): `number` -Defined in: [src/canvas/StaticCanvas.ts:283](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L283) +Defined in: [src/canvas/StaticCanvas.ts:287](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L287) Returns canvas width (in px) @@ -2743,9 +2743,9 @@ Returns canvas width (in px) > **getZoom**(): `number` -Defined in: [src/canvas/StaticCanvas.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L353) +Defined in: [src/canvas/StaticCanvas.ts:357](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L357) -Returns canvas zoom level +Returns the canvas zoom level as the magnitude of the viewport scale. #### Returns @@ -2761,7 +2761,7 @@ Returns canvas zoom level > **insertAt**(`index`, ...`objects`): `number` -Defined in: [src/canvas/StaticCanvas.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L225) +Defined in: [src/canvas/StaticCanvas.ts:229](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L229) Inserts an object into collection at specified index @@ -2795,7 +2795,7 @@ new array length > **isEmpty**(): `boolean` -Defined in: [src/Collection.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L128) +Defined in: [src/Collection.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L128) Returns true if collection contains no objects @@ -2815,7 +2815,7 @@ true if collection is empty > **isTargetTransparent**(`target`, `x`, `y`): `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:461](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L461) +Defined in: [src/canvas/SelectableCanvas.ts:468](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L468) Returns true if object is transparent at a certain location Clarification: this is `is target transparent at location X or are controls there` @@ -2859,7 +2859,7 @@ programmatically without painting them, the cache canvas optimization is always > **item**(`index`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/Collection.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L120) +Defined in: [src/Collection.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L120) Returns object at specified index @@ -2885,7 +2885,7 @@ object at index > **loadFromJSON**(`json`, `reviver?`, `options?`): `Promise`\<`Canvas`\> -Defined in: [src/canvas/StaticCanvas.ts:1232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1232) +Defined in: [src/canvas/StaticCanvas.ts:1241](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1241) Populates canvas with data from the specified JSON. JSON format must conform to the one of fabric.Canvas#toJSON @@ -2902,9 +2902,10 @@ JSON string or object ##### reviver? -\<`T`\>(`serializedObj`, `instance`) => `void` +\<`T`\>(`serializedObj`, `instance`, `error?`) => `void` \| `Promise`\<`T`\> -Method for further parsing of JSON elements, called after each fabric object created. +Method for further parsing of JSON elements, called after each fabric object created with the instance +if creation was successfully or with defined error if not. If a FabricObject is returned in the reviver, and an error occurred, this instance will be used in place of that one witch generated error. ##### options? @@ -2930,10 +2931,14 @@ canvas.loadFromJSON(json).then((canvas) => canvas.requestRenderAll()); ``` ```ts -canvas.loadFromJSON(json, function(o, object) { +canvas.loadFromJSON(json, function(o, object, error) { // `o` = json object - // `object` = fabric.Object instance + // `object` = fabric.Object instance or undefined + // `error` = FabricError or undefined // ... do some stuff ... + if(error){ + return new FabricText('placeholder-object'); + } }).then((canvas) => { ... canvas is restored, add your code. }); @@ -2949,7 +2954,7 @@ canvas.loadFromJSON(json, function(o, object) { > **moveObjectTo**(`object`, `index`): `boolean` -Defined in: [src/Collection.ts:262](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L262) +Defined in: [src/Collection.ts:262](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L262) Moves an object to specified level in stack of drawn objects @@ -2985,7 +2990,7 @@ true if change occurred > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -3021,7 +3026,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -3057,7 +3062,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -3081,7 +3086,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -3101,7 +3106,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -3147,7 +3152,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -3181,7 +3186,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -3227,7 +3232,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -3259,7 +3264,7 @@ once > **relativePan**(`point`): `void` -Defined in: [src/canvas/StaticCanvas.ts:411](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L411) +Defined in: [src/canvas/StaticCanvas.ts:415](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L415) Pans viewpoint relatively @@ -3285,7 +3290,7 @@ Pans viewpoint relatively > **removeListeners**(): `void` -Defined in: [src/canvas/Canvas.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L201) +Defined in: [src/canvas/Canvas.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L201) Removes all event listeners, used when disposing the instance @@ -3299,7 +3304,7 @@ Removes all event listeners, used when disposing the instance > **renderAll**(): `void` -Defined in: [src/canvas/SelectableCanvas.ts:389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L389) +Defined in: [src/canvas/SelectableCanvas.ts:396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L396) Renders both the top canvas and the secondary container canvas. @@ -3317,7 +3322,7 @@ Renders both the top canvas and the secondary container canvas. > **renderCanvas**(`ctx`, `objects`): `void` -Defined in: [src/canvas/StaticCanvas.ts:531](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L531) +Defined in: [src/canvas/StaticCanvas.ts:535](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L535) Renders background, objects, overlay and controls. @@ -3347,7 +3352,7 @@ to render > **renderTop**(): `void` -Defined in: [src/canvas/SelectableCanvas.ts:429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L429) +Defined in: [src/canvas/SelectableCanvas.ts:436](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L436) Method to render only the top canvas. Also used to render the group selection box. @@ -3367,7 +3372,7 @@ Does not render text selection. > **renderTopLayer**(`ctx`): `void` -Defined in: [src/canvas/SelectableCanvas.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L410) +Defined in: [src/canvas/SelectableCanvas.ts:417](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L417) text selection is rendered by the active text instance during the rendering cycle @@ -3391,7 +3396,7 @@ text selection is rendered by the active text instance during the rendering cycl > **requestRenderAll**(): `void` -Defined in: [src/canvas/StaticCanvas.ts:487](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L487) +Defined in: [src/canvas/StaticCanvas.ts:491](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L491) Append a renderAll request to next animation frame. unless one is already in progress, in that case nothing is done @@ -3411,7 +3416,7 @@ a boolean flag will avoid appending more. > **searchPossibleTargets**(`objects`, `pointer`): `TargetsInfoWithContainer` -Defined in: [src/canvas/SelectableCanvas.ts:959](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L959) +Defined in: [src/canvas/SelectableCanvas.ts:971](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L971) Search inside an objects array the fiurst object that contains pointer Collect subTargets of that object inside the subTargets array passed as parameter @@ -3446,7 +3451,7 @@ coordinates from viewport to check. > **sendObjectBackwards**(`object`, `intersecting?`): `boolean` -Defined in: [src/Collection.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L214) +Defined in: [src/Collection.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L214) Moves an object or a selection down in stack of drawn objects An optional parameter, `intersecting` allows to move the object in behind @@ -3484,7 +3489,7 @@ true if change occurred > **sendObjectToBack**(`object`): `boolean` -Defined in: [src/Collection.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L178) +Defined in: [src/Collection.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L178) Moves an object or the objects of a multiple selection to the bottom of the stack of drawn objects @@ -3513,7 +3518,7 @@ true if change occurred > **set**(`key`, `value?`): `Canvas` -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -3545,7 +3550,7 @@ Property value (if function, the value is passed into it and its return value is > **setActiveObject**(`object`, `e?`): `boolean` -Defined in: [src/canvas/SelectableCanvas.ts:1225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1225) +Defined in: [src/canvas/SelectableCanvas.ts:1237](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1237) Sets given object as the only active object on canvas @@ -3579,7 +3584,7 @@ true if the object has been selected > **setCursor**(`value`): `void` -Defined in: [src/canvas/SelectableCanvas.ts:699](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L699) +Defined in: [src/canvas/SelectableCanvas.ts:706](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L706) Set the cursor type of the canvas element @@ -3611,7 +3616,7 @@ http://www.w3.org/TR/css3-ui/#cursor > **setDimensions**(`dimensions`, `options?`): `void` -Defined in: [src/canvas/StaticCanvas.ts:330](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L330) +Defined in: [src/canvas/StaticCanvas.ts:334](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L334) Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em) @@ -3651,7 +3656,7 @@ Set the given dimensions only as css dimensions > **setDimensions**(`dimensions`, `options?`): `void` -Defined in: [src/canvas/StaticCanvas.ts:334](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L334) +Defined in: [src/canvas/StaticCanvas.ts:338](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L338) Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em) @@ -3691,7 +3696,7 @@ Set the given dimensions only as css dimensions > **setDimensions**(`dimensions`, `options?`): `void` -Defined in: [src/canvas/StaticCanvas.ts:338](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L338) +Defined in: [src/canvas/StaticCanvas.ts:342](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L342) Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em) @@ -3723,7 +3728,7 @@ Options object > **setViewportTransform**(`vpt`): `void` -Defined in: [src/canvas/SelectableCanvas.ts:1363](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L1363) +Defined in: [src/canvas/SelectableCanvas.ts:1375](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L1375) Sets viewport transformation of this canvas instance @@ -3749,7 +3754,7 @@ a Canvas 2D API transform matrix > **setZoom**(`value`): `void` -Defined in: [src/canvas/StaticCanvas.ts:392](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L392) +Defined in: [src/canvas/StaticCanvas.ts:396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L396) Sets zoom level of this canvas instance @@ -3775,7 +3780,7 @@ to set zoom to, less than 1 zooms out > **size**(): `number` -Defined in: [src/Collection.ts:136](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L136) +Defined in: [src/Collection.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L136) Returns a size of a collection (i.e: length of an array containing its objects) @@ -3795,7 +3800,7 @@ Collection size > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/canvas/StaticCanvas.ts:1347](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1347) +Defined in: [src/canvas/StaticCanvas.ts:1356](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1356) #### Parameters @@ -3817,7 +3822,7 @@ Defined in: [src/canvas/StaticCanvas.ts:1347](https://github.com/fabricjs/fabric > **toCanvasElement**(`multiplier`, `options?`): `HTMLCanvasElement` -Defined in: [src/canvas/Canvas.ts:1580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/Canvas.ts#L1580) +Defined in: [src/canvas/Canvas.ts:1604](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/Canvas.ts#L1604) Wraps the original toCanvasElement with a function that removes the context top for the time the function is run. @@ -3847,7 +3852,7 @@ So we avoid painting side effects on the upper canvas when exporting > **toDatalessJSON**(`propertiesToInclude?`): `any` -Defined in: [src/canvas/StaticCanvas.ts:773](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L773) +Defined in: [src/canvas/StaticCanvas.ts:777](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L777) Returns dataless JSON representation of canvas @@ -3875,7 +3880,7 @@ json string > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/canvas/StaticCanvas.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L809) +Defined in: [src/canvas/StaticCanvas.ts:813](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L813) Returns dataless object representation of canvas @@ -3903,7 +3908,7 @@ object representation of an instance > **toDataURL**(`options?`): `string` -Defined in: [src/canvas/StaticCanvas.ts:1331](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1331) +Defined in: [src/canvas/StaticCanvas.ts:1340](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1340) Exports canvas element to a dataurl image. Note that when multiplier is used, cropping is scaled appropriately @@ -3968,7 +3973,7 @@ var dataURL = canvas.toDataURL({ > **toggle**(`property`): `Canvas` -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -3994,7 +3999,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/canvas/StaticCanvas.ts:800](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L800) +Defined in: [src/canvas/StaticCanvas.ts:804](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L804) Returns Object representation of canvas this alias is provided because if you call JSON.stringify on an instance, @@ -4033,7 +4038,7 @@ const json = JSON.stringify(canvas); > **toObject**(`propertiesToInclude?`): `any` -Defined in: [src/canvas/StaticCanvas.ts:782](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L782) +Defined in: [src/canvas/StaticCanvas.ts:786](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L786) Returns object representation of canvas @@ -4061,7 +4066,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/canvas/StaticCanvas.ts:1481](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1481) +Defined in: [src/canvas/StaticCanvas.ts:1490](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1490) Returns a string representation of an instance @@ -4081,7 +4086,7 @@ string representation of an instance > **toSVG**(`options?`, `reviver?`): `string` -Defined in: [src/canvas/StaticCanvas.ts:947](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L947) +Defined in: [src/canvas/StaticCanvas.ts:951](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L951) Returns SVG representation of canvas @@ -4151,7 +4156,7 @@ var svg = canvas.toSVG(null, function(svg) { > **viewportCenterObject**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:720](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L720) +Defined in: [src/canvas/StaticCanvas.ts:724](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L724) Centers object vertically and horizontally in the viewport @@ -4177,7 +4182,7 @@ Object to center vertically and horizontally > **viewportCenterObjectH**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:728](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L728) +Defined in: [src/canvas/StaticCanvas.ts:732](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L732) Centers object horizontally in the viewport, object.top is unchanged @@ -4203,7 +4208,7 @@ Object to center vertically and horizontally > **viewportCenterObjectV**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:739](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L739) +Defined in: [src/canvas/StaticCanvas.ts:743](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L743) Centers object Vertically in the viewport, object.top is unchanged @@ -4229,7 +4234,7 @@ Object to center vertically and horizontally > **zoomToPoint**(`point`, `value`): `void` -Defined in: [src/canvas/StaticCanvas.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L375) +Defined in: [src/canvas/StaticCanvas.ts:379](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L379) Sets zoom level of this canvas instance, the zoom centered around point meaning that following zoom to point with the same point will have the visual @@ -4264,7 +4269,7 @@ to set zoom to, less than 1 zooms out > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/canvas/SelectableCanvas.ts:307](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/SelectableCanvas.ts#L307) +Defined in: [src/canvas/SelectableCanvas.ts:314](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/SelectableCanvas.ts#L314) #### Returns diff --git a/src/content/docs/api/classes/Canvas2dFilterBackend.md b/src/content/docs/api/classes/Canvas2dFilterBackend.md index 16b44bef..f1f1f7a4 100644 --- a/src/content/docs/api/classes/Canvas2dFilterBackend.md +++ b/src/content/docs/api/classes/Canvas2dFilterBackend.md @@ -5,7 +5,7 @@ prev: false title: "Canvas2dFilterBackend" --- -Defined in: [src/filters/Canvas2dFilterBackend.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Canvas2dFilterBackend.ts#L7) +Defined in: [src/filters/Canvas2dFilterBackend.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Canvas2dFilterBackend.ts#L7) ## Constructors @@ -23,7 +23,7 @@ Defined in: [src/filters/Canvas2dFilterBackend.ts:7](https://github.com/fabricjs > **resources**: [`TPipelineResources`](/api/type-aliases/tpipelineresources/) = `{}` -Defined in: [src/filters/Canvas2dFilterBackend.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Canvas2dFilterBackend.ts#L15) +Defined in: [src/filters/Canvas2dFilterBackend.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Canvas2dFilterBackend.ts#L15) Experimental. This object is a sort of repository of help layers used to avoid of recreating them during frequent filtering. If you are previewing a filter with @@ -37,7 +37,7 @@ cleared never. Clearing is left to the developer. > **applyFilters**(`filters`, `sourceElement`, `sourceWidth`, `sourceHeight`, `targetCanvas`): `void` \| [`T2DPipelineState`](/api/type-aliases/t2dpipelinestate/) -Defined in: [src/filters/Canvas2dFilterBackend.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Canvas2dFilterBackend.ts#L27) +Defined in: [src/filters/Canvas2dFilterBackend.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Canvas2dFilterBackend.ts#L27) Apply a set of filters against a source image and draw the filtered output to the provided destination canvas. @@ -46,7 +46,7 @@ to the provided destination canvas. ##### filters -[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\>[] +[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>[] The filter to apply. diff --git a/src/content/docs/api/classes/CanvasDOMManager.md b/src/content/docs/api/classes/CanvasDOMManager.md index e56a82b0..c37d4136 100644 --- a/src/content/docs/api/classes/CanvasDOMManager.md +++ b/src/content/docs/api/classes/CanvasDOMManager.md @@ -5,7 +5,7 @@ prev: false title: "CanvasDOMManager" --- -Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/CanvasDOMManager.ts#L12) +Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/CanvasDOMManager.ts#L12) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:12](https://github.com/f > **new CanvasDOMManager**(`arg0?`, `__namedParameters?`): `CanvasDOMManager` -Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/CanvasDOMManager.ts#L16) +Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/CanvasDOMManager.ts#L16) #### Parameters @@ -53,7 +53,7 @@ here only for backward compatibility > **container**: `HTMLDivElement` -Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/CanvasDOMManager.ts#L14) +Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/CanvasDOMManager.ts#L14) *** @@ -61,7 +61,7 @@ Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:14](https://github.com/f > **lower**: `CanvasItem` -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L22) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L22) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:22](https://github > **upper**: `CanvasItem` -Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/CanvasDOMManager.ts#L13) +Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:13](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/CanvasDOMManager.ts#L13) ## Methods @@ -81,7 +81,7 @@ Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:13](https://github.com/f > **calcOffset**(): `object` -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L71) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L71) Calculates canvas element offset relative to the document @@ -107,7 +107,7 @@ Calculates canvas element offset relative to the document > **cleanupDOM**(`size`): `void` -Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/CanvasDOMManager.ts#L109) +Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/CanvasDOMManager.ts#L109) #### Parameters @@ -129,7 +129,7 @@ Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:109](https://github.com/ > **dispose**(): `void` -Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/CanvasDOMManager.ts#L121) +Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/CanvasDOMManager.ts#L121) #### Returns @@ -145,7 +145,7 @@ Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:121](https://github.com/ > **setCSSDimensions**(`size`): `void` -Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/CanvasDOMManager.ts#L103) +Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/CanvasDOMManager.ts#L103) #### Parameters @@ -167,7 +167,7 @@ Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:103](https://github.com/ > **setDimensions**(`size`, `retinaScaling`): `void` -Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:97](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/CanvasDOMManager.ts#L97) +Defined in: [src/canvas/DOMManagers/CanvasDOMManager.ts:97](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/CanvasDOMManager.ts#L97) #### Parameters diff --git a/src/content/docs/api/classes/Circle.md b/src/content/docs/api/classes/Circle.md index 4ed185ea..c1b804c6 100644 --- a/src/content/docs/api/classes/Circle.md +++ b/src/content/docs/api/classes/Circle.md @@ -5,7 +5,7 @@ prev: false title: "Circle" --- -Defined in: [src/shapes/Circle.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L65) +Defined in: [src/shapes/Circle.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L65) Exported so we can tweak default values @@ -37,7 +37,7 @@ Exported so we can tweak default values > **new Circle**\<`Props`, `SProps`, `EventSpec`\>(`options?`): `Circle`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Circle.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L95) +Defined in: [src/shapes/Circle.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L95) Constructor @@ -63,7 +63,7 @@ Options object > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -81,7 +81,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -97,7 +97,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -119,7 +119,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -144,7 +144,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -163,7 +163,7 @@ You can calculate them without updating with [()](/api/classes/circle/#calcacoor > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -183,7 +183,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -198,7 +198,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -218,7 +218,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -236,7 +236,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -256,7 +256,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -280,7 +280,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -302,7 +302,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -321,7 +321,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -338,7 +338,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -353,7 +353,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -368,7 +368,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -388,7 +388,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -412,7 +412,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -432,7 +432,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -456,7 +456,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -486,7 +486,7 @@ This API is no longer supported and may be removed in a future release. > **counterClockwise**: `boolean` -Defined in: [src/shapes/Circle.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L76) +Defined in: [src/shapes/Circle.ts:76](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L76) Orientation for the direction of the circle. Setting to true will switch the arc of the circle to traverse from startAngle to endAngle in a counter-clockwise direction. @@ -508,7 +508,7 @@ false > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -529,7 +529,7 @@ true > **endAngle**: `number` -Defined in: [src/shapes/Circle.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L75) +Defined in: [src/shapes/Circle.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L75) Angle for the end of the circle, in degrees @@ -549,7 +549,7 @@ Angle for the end of the circle, in degrees > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -563,7 +563,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -581,7 +581,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -602,7 +602,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -624,7 +624,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -644,7 +644,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -664,7 +664,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -678,7 +678,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -692,7 +692,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -712,7 +712,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -726,7 +726,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -746,7 +746,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -760,7 +760,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -782,7 +782,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -797,7 +797,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -819,7 +819,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -833,7 +833,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -847,7 +847,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -861,7 +861,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -875,7 +875,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -889,7 +889,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -903,7 +903,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -917,7 +917,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -931,7 +931,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -945,7 +945,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -965,7 +965,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -985,11 +985,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1009,7 +1009,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1035,7 +1035,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1052,7 +1052,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1072,7 +1072,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1088,7 +1088,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1104,7 +1104,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1118,7 +1118,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1138,7 +1138,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1152,7 +1152,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1167,7 +1167,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1181,7 +1181,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **radius**: `number` -Defined in: [src/shapes/Circle.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L73) +Defined in: [src/shapes/Circle.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L73) Radius of this circle @@ -1201,7 +1201,7 @@ Radius of this circle > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1221,7 +1221,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1241,7 +1241,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1256,7 +1256,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1275,7 +1275,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1295,7 +1295,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1315,7 +1315,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1335,7 +1335,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1349,7 +1349,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1364,7 +1364,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **startAngle**: `number` -Defined in: [src/shapes/Circle.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L74) +Defined in: [src/shapes/Circle.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L74) Angle for the start of the circle, in degrees. @@ -1384,7 +1384,7 @@ Angle for the start of the circle, in degrees. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1405,7 +1405,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1425,7 +1425,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1445,7 +1445,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1465,7 +1465,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1479,7 +1479,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1499,7 +1499,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1532,7 +1532,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1552,7 +1552,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1574,7 +1574,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1594,7 +1594,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1614,7 +1614,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1628,7 +1628,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1642,7 +1642,7 @@ Object width > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Circle.ts:212](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L212) +Defined in: [src/shapes/Circle.ts:212](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L212) List of attribute names to account for when parsing SVG element (used by [Circle.fromElement](/api/classes/circle/#fromelement)) @see: http://www.w3.org/TR/SVG/shapes.html#CircleElement @@ -1653,7 +1653,7 @@ List of attribute names to account for when parsing SVG element (used by [Circle > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Circle.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L80) +Defined in: [src/shapes/Circle.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L80) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1670,7 +1670,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1684,7 +1684,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1699,7 +1699,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`Circle`\<`Partial`\<[`CircleProps`](/api/interfaces/circleprops/)\>, [`SerializedCircleProps`](/api/interfaces/serializedcircleprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `circleDefaultValues` -Defined in: [src/shapes/Circle.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L82) +Defined in: [src/shapes/Circle.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L82) #### Overrides @@ -1711,7 +1711,7 @@ Defined in: [src/shapes/Circle.ts:82](https://github.com/fabricjs/fabric.js/blob > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1727,7 +1727,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Circle'` -Defined in: [src/shapes/Circle.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L78) +Defined in: [src/shapes/Circle.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L78) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1750,7 +1750,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1773,7 +1773,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1795,7 +1795,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -1827,7 +1827,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -1857,7 +1857,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -1875,7 +1875,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -1912,7 +1912,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -1934,7 +1934,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -1960,7 +1960,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -1986,7 +1986,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2013,7 +2013,7 @@ Rendering canvas context > **\_toSVG**(): `string`[] -Defined in: [src/shapes/Circle.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L176) +Defined in: [src/shapes/Circle.ts:176](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L176) Returns svg representation of an instance @@ -2034,7 +2034,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2056,7 +2056,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2103,7 +2103,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2122,7 +2122,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2143,7 +2143,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2164,7 +2164,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2194,7 +2194,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2220,7 +2220,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2256,7 +2256,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Circle`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2282,7 +2282,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2319,7 +2319,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1429) +Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1429) Returns complexity of an instance @@ -2339,7 +2339,7 @@ complexity of this instance (is 1 unless subclassed) > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2367,7 +2367,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2386,7 +2386,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2426,7 +2426,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2456,7 +2456,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2490,7 +2490,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2527,7 +2527,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2561,7 +2561,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2599,7 +2599,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2634,7 +2634,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2666,7 +2666,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2704,7 +2704,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2731,7 +2731,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2759,7 +2759,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -2775,7 +2775,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -2793,7 +2793,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -2814,7 +2814,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -2830,7 +2830,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -2848,7 +2848,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -2866,7 +2866,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -2884,7 +2884,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -2902,7 +2902,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/circle/#getpositionbyorigin) @@ -2934,7 +2934,7 @@ use [getPositionByOrigin](/api/classes/circle/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/circle/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -2972,7 +2972,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRadiusX**(): `number` -Defined in: [src/shapes/Circle.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L137) +Defined in: [src/shapes/Circle.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L137) Returns horizontal radius of an object (according to how an object is scaled) @@ -2986,7 +2986,7 @@ Returns horizontal radius of an object (according to how an object is scaled) > **getRadiusY**(): `number` -Defined in: [src/shapes/Circle.ts:145](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L145) +Defined in: [src/shapes/Circle.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L145) Returns vertical radius of an object (according to how an object is scaled) @@ -3000,7 +3000,7 @@ Returns vertical radius of an object (according to how an object is scaled) > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3018,7 +3018,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3037,7 +3037,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/circl > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3055,7 +3055,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3074,7 +3074,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/circl > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3098,7 +3098,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3122,7 +3122,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3146,7 +3146,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3170,7 +3170,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3200,7 +3200,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3232,7 +3232,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3250,7 +3250,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3270,7 +3270,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3288,7 +3288,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3306,7 +3306,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3324,7 +3324,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3342,7 +3342,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3370,7 +3370,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3399,7 +3399,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3428,7 +3428,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3456,7 +3456,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3484,7 +3484,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3514,7 +3514,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3542,7 +3542,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3570,7 +3570,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3599,7 +3599,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3624,7 +3624,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3656,7 +3656,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3674,7 +3674,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3695,7 +3695,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3723,7 +3723,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3743,7 +3743,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -3779,7 +3779,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -3805,7 +3805,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -3841,7 +3841,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -3877,7 +3877,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -3901,7 +3901,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -3921,7 +3921,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -3967,7 +3967,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4001,7 +4001,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4047,7 +4047,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4079,7 +4079,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4112,7 +4112,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4139,7 +4139,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4170,7 +4170,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4196,7 +4196,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4222,7 +4222,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4248,7 +4248,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4274,7 +4274,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4301,7 +4301,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4327,7 +4327,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4353,7 +4353,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4379,7 +4379,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4405,7 +4405,7 @@ New width value > **set**(`key`, `value?`): `Circle`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4437,7 +4437,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4464,7 +4464,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4502,7 +4502,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4521,7 +4521,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4542,7 +4542,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4580,7 +4580,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRadius**(`value`): `void` -Defined in: [src/shapes/Circle.ts:152](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L152) +Defined in: [src/shapes/Circle.ts:152](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L152) Sets radius of an object (and updates width accordingly) @@ -4600,7 +4600,7 @@ Sets radius of an object (and updates width accordingly) > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4625,7 +4625,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/circle/ > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/circle/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4663,7 +4663,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4688,7 +4688,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/circl > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4712,7 +4712,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4758,7 +4758,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4782,7 +4782,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -4805,7 +4805,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -4832,7 +4832,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -4864,7 +4864,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -4886,7 +4886,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -4914,7 +4914,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -4946,7 +4946,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -4974,7 +4974,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -5002,7 +5002,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Circle`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -5028,7 +5028,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5048,7 +5048,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Circle.ts:162](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L162) +Defined in: [src/shapes/Circle.ts:162](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L162) Returns object representation of an instance @@ -5086,7 +5086,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -5104,7 +5104,7 @@ Returns a string representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5136,7 +5136,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5162,7 +5162,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5184,7 +5184,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5222,7 +5222,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5272,7 +5272,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5310,7 +5310,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5333,7 +5333,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5365,7 +5365,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5389,7 +5389,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<`Circle`\<`Partial`\<[`CircleProps`](/api/interfaces/circleprops/)\>, [`SerializedCircleProps`](/api/interfaces/serializedcircleprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Circle.ts:220](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L220) +Defined in: [src/shapes/Circle.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L220) Returns [Circle](/api/classes/circle/) instance from an SVG element @@ -5425,7 +5425,7 @@ If value of `r` attribute is missing or invalid > `static` **fromObject**\<`T`\>(`object`): `Promise`\<`Circle`\<`Partial`\<[`CircleProps`](/api/interfaces/circleprops/)\>, [`SerializedCircleProps`](/api/interfaces/serializedcircleprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Circle.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L251) +Defined in: [src/shapes/Circle.ts:251](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L251) #### Type Parameters @@ -5457,7 +5457,7 @@ how do we declare this?? > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Circle.ts:84](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L84) +Defined in: [src/shapes/Circle.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L84) #### Returns diff --git a/src/content/docs/api/classes/CircleBrush.md b/src/content/docs/api/classes/CircleBrush.md index eb48cc17..795b11ff 100644 --- a/src/content/docs/api/classes/CircleBrush.md +++ b/src/content/docs/api/classes/CircleBrush.md @@ -5,7 +5,7 @@ prev: false title: "CircleBrush" --- -Defined in: [src/brushes/CircleBrush.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L12) +Defined in: [src/brushes/CircleBrush.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L12) ## See @@ -21,7 +21,7 @@ Defined in: [src/brushes/CircleBrush.ts:12](https://github.com/fabricjs/fabric.j > **new CircleBrush**(`canvas`): `CircleBrush` -Defined in: [src/brushes/CircleBrush.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L21) +Defined in: [src/brushes/CircleBrush.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L21) #### Parameters @@ -43,7 +43,7 @@ Defined in: [src/brushes/CircleBrush.ts:21](https://github.com/fabricjs/fabric.j > **canvas**: [`Canvas`](/api/classes/canvas/) -Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L66) +Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L66) #### Todo @@ -59,7 +59,7 @@ add type > **color**: `string` = `'rgb(0, 0, 0)'` -Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L15) +Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L15) Color of a brush @@ -73,7 +73,7 @@ Color of a brush > **limitedToCanvasSize**: `boolean` = `false` -Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L61) +Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L61) When `true`, the free drawing is limited to the whiteboard size. Default to false. @@ -93,7 +93,7 @@ false > **points**: [`CircleBrushPoint`](/api/type-aliases/circlebrushpoint/)[] -Defined in: [src/brushes/CircleBrush.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L19) +Defined in: [src/brushes/CircleBrush.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L19) *** @@ -101,7 +101,7 @@ Defined in: [src/brushes/CircleBrush.ts:19](https://github.com/fabricjs/fabric.j > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) = `null` -Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L29) +Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L29) Shadow object representing shadow of this shape. Backwards incompatibility note: This property replaces "shadowColor" (String), "shadowOffsetX" (Number), @@ -117,7 +117,7 @@ Shadow object representing shadow of this shape. > **strokeDashArray**: `null` \| `number`[] = `null` -Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L53) +Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L53) Stroke Dash Array. @@ -131,7 +131,7 @@ Stroke Dash Array. > **strokeLineCap**: `CanvasLineCap` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L35) +Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L35) Line endings style of a brush (one of "butt", "round", "square") @@ -145,7 +145,7 @@ Line endings style of a brush (one of "butt", "round", "square") > **strokeLineJoin**: `CanvasLineJoin` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L41) +Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L41) Corner style of a brush (one of "bevel", "round", "miter") @@ -159,7 +159,7 @@ Corner style of a brush (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` = `10` -Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L47) +Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L47) Maximum miter length (used for strokeLineJoin = "miter") of a brush's @@ -173,7 +173,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of a brush's > **width**: `number` = `10` -Defined in: [src/brushes/CircleBrush.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L17) +Defined in: [src/brushes/CircleBrush.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L17) Width of a brush @@ -187,7 +187,7 @@ Width of a brush > **addPoint**(`pointer`): [`CircleBrushPoint`](/api/type-aliases/circlebrushpoint/) -Defined in: [src/brushes/CircleBrush.ts:127](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L127) +Defined in: [src/brushes/CircleBrush.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L127) #### Parameters @@ -207,7 +207,7 @@ Just added pointer point > **dot**(`ctx`, `point`): `void` -Defined in: [src/brushes/CircleBrush.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L38) +Defined in: [src/brushes/CircleBrush.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L38) #### Parameters @@ -229,7 +229,7 @@ Defined in: [src/brushes/CircleBrush.ts:38](https://github.com/fabricjs/fabric.j > **drawDot**(`pointer`): `void` -Defined in: [src/brushes/CircleBrush.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L30) +Defined in: [src/brushes/CircleBrush.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L30) Invoked inside on mouse down and mouse move @@ -249,7 +249,7 @@ Invoked inside on mouse down and mouse move > **onMouseDown**(`pointer`): `void` -Defined in: [src/brushes/CircleBrush.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L49) +Defined in: [src/brushes/CircleBrush.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L49) Invoked on mouse down @@ -273,7 +273,7 @@ Invoked on mouse down > **onMouseMove**(`pointer`): `void` -Defined in: [src/brushes/CircleBrush.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L74) +Defined in: [src/brushes/CircleBrush.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L74) Invoked on mouse move @@ -297,7 +297,7 @@ Invoked on mouse move > **onMouseUp**(): `void` -Defined in: [src/brushes/CircleBrush.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/CircleBrush.ts#L90) +Defined in: [src/brushes/CircleBrush.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/CircleBrush.ts#L90) Invoked on mouse up diff --git a/src/content/docs/api/classes/ClipPathLayout.md b/src/content/docs/api/classes/ClipPathLayout.md index 5d9ae0ef..729b688a 100644 --- a/src/content/docs/api/classes/ClipPathLayout.md +++ b/src/content/docs/api/classes/ClipPathLayout.md @@ -5,7 +5,7 @@ prev: false title: "ClipPathLayout" --- -Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L13) +Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:13](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L13) Layout will adjust the bounding box to match the clip path bounding box. @@ -33,7 +33,7 @@ Layout will adjust the bounding box to match the clip path bounding box. > `readonly` `static` **type**: `"clip-path"` = `'clip-path'` -Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L14) +Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L14) override by subclass for persistence (TS does not support `static abstract`) @@ -47,7 +47,7 @@ override by subclass for persistence (TS does not support `static abstract`) > **calcBoundingBox**(`objects`, `context`): `undefined` \| [`LayoutStrategyResult`](/api/type-aliases/layoutstrategyresult/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L68) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L68) Override this method to customize layout. @@ -75,7 +75,7 @@ Override this method to customize layout. > **calcLayoutResult**(`context`, `objects`): `undefined` \| [`LayoutStrategyResult`](/api/type-aliases/layoutstrategyresult/) -Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L24) +Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L24) Used by the `LayoutManager` to perform layout @TODO/fix: if this method is calcResult, should calc unconditionally. @@ -107,7 +107,7 @@ layout result **OR** `undefined` to skip layout > **getInitialSize**(`context`, `result`): [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L58) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L58) #### Parameters @@ -133,7 +133,7 @@ Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:58](https://gi > **shouldLayoutClipPath**(): `boolean` -Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L20) +Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L20) #### Returns @@ -149,7 +149,7 @@ Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:20](https://gi > **shouldPerformLayout**(`context`): `boolean` -Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L16) +Defined in: [src/LayoutManager/LayoutStrategies/ClipPathLayout.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/ClipPathLayout.ts#L16) #### Parameters diff --git a/src/content/docs/api/classes/Color.md b/src/content/docs/api/classes/Color.md index c83f75af..898d2b58 100644 --- a/src/content/docs/api/classes/Color.md +++ b/src/content/docs/api/classes/Color.md @@ -5,7 +5,7 @@ prev: false title: "Color" --- -Defined in: [src/color/Color.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L18) +Defined in: [src/color/Color.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L18) Color common color operations @@ -19,7 +19,7 @@ Color common color operations > **new Color**(`color?`): `Color` -Defined in: [src/color/Color.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L26) +Defined in: [src/color/Color.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L26) #### Parameters @@ -39,7 +39,7 @@ optional in hex or rgb(a) or hsl format or from known color list > **isUnrecognised**: `boolean` = `false` -Defined in: [src/color/Color.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L20) +Defined in: [src/color/Color.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L20) ## Methods @@ -47,7 +47,7 @@ Defined in: [src/color/Color.ts:20](https://github.com/fabricjs/fabric.js/blob/2 > **getAlpha**(): `number` -Defined in: [src/color/Color.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L134) +Defined in: [src/color/Color.ts:134](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L134) Gets value of alpha channel for this color @@ -63,7 +63,7 @@ Gets value of alpha channel for this color > **getSource**(): [`TRGBAColorSource`](/api/type-aliases/trgbacolorsource/) -Defined in: [src/color/Color.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L65) +Defined in: [src/color/Color.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L65) Returns source of this color (where source is an array representation; ex: [200, 200, 100, 1]) @@ -77,7 +77,7 @@ Returns source of this color (where source is an array representation; ex: [200, > **overlayWith**(`otherColor`): `Color` -Defined in: [src/color/Color.ts:174](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L174) +Defined in: [src/color/Color.ts:174](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L174) Overlays color with another color @@ -99,7 +99,7 @@ thisArg > **setAlpha**(`alpha`): `Color` -Defined in: [src/color/Color.ts:143](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L143) +Defined in: [src/color/Color.ts:143](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L143) Sets value of alpha channel for this color @@ -123,7 +123,7 @@ thisArg > **setSource**(`source`): `void` -Defined in: [src/color/Color.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L73) +Defined in: [src/color/Color.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L73) Sets source of this color (where source is an array representation; ex: [200, 200, 100, 1]) @@ -143,7 +143,7 @@ Sets source of this color (where source is an array representation; ex: [200, 20 > **toBlackWhite**(`threshold`): `Color` -Defined in: [src/color/Color.ts:162](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L162) +Defined in: [src/color/Color.ts:162](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L162) Transforms color to its black and white representation @@ -165,7 +165,7 @@ thisArg > **toGrayscale**(): `Color` -Defined in: [src/color/Color.ts:152](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L152) +Defined in: [src/color/Color.ts:152](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L152) Transforms color to its grayscale representation @@ -181,7 +181,7 @@ thisArg > **toHex**(): `string` -Defined in: [src/color/Color.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L116) +Defined in: [src/color/Color.ts:116](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L116) Returns color representation in HEX format @@ -197,7 +197,7 @@ ex: FF5555 > **toHexa**(): `string` -Defined in: [src/color/Color.ts:125](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L125) +Defined in: [src/color/Color.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L125) Returns color representation in HEXA format @@ -213,7 +213,7 @@ ex: FF5555CC > **toHsl**(): `string` -Defined in: [src/color/Color.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L98) +Defined in: [src/color/Color.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L98) Returns color representation in HSL format @@ -229,7 +229,7 @@ ex: hsl(0-360,0%-100%,0%-100%) > **toHsla**(): `string` -Defined in: [src/color/Color.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L107) +Defined in: [src/color/Color.ts:107](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L107) Returns color representation in HSLA format @@ -245,7 +245,7 @@ ex: hsla(0-360,0%-100%,0%-100%,0-1) > **toRgb**(): `string` -Defined in: [src/color/Color.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L81) +Defined in: [src/color/Color.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L81) Returns color representation in RGB format @@ -261,7 +261,7 @@ ex: rgb(0-255,0-255,0-255) > **toRgba**(): `string` -Defined in: [src/color/Color.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L90) +Defined in: [src/color/Color.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L90) Returns color representation in RGBA format @@ -277,7 +277,7 @@ ex: rgba(0-255,0-255,0-255,0-1) > `static` **fromHex**(`color`): `Color` -Defined in: [src/color/Color.ts:287](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L287) +Defined in: [src/color/Color.ts:287](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L287) Returns new color object, when given a color in HEX format @@ -299,7 +299,7 @@ Color value ex: FF5555 > `static` **fromHsl**(`color`): `Color` -Defined in: [src/color/Color.ts:231](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L231) +Defined in: [src/color/Color.ts:231](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L231) Returns new color object, when given a color in HSL format @@ -321,7 +321,7 @@ Color value ex: hsl(0-260,0%-100%,0%-100%) > `static` **fromHsla**(`color`): `Color` -Defined in: [src/color/Color.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L240) +Defined in: [src/color/Color.ts:240](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L240) Returns new color object, when given a color in HSLA format @@ -341,7 +341,7 @@ Returns new color object, when given a color in HSLA format > `static` **fromRgb**(`color`): `Color` -Defined in: [src/color/Color.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L195) +Defined in: [src/color/Color.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L195) Returns new color object, when given a color in RGB format @@ -363,7 +363,7 @@ Color value ex: rgb(0-255,0-255,0-255) > `static` **fromRgba**(`color`): `Color` -Defined in: [src/color/Color.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L204) +Defined in: [src/color/Color.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L204) Returns new color object, when given a color in RGBA format @@ -383,7 +383,7 @@ Returns new color object, when given a color in RGBA format > `static` **parseAngletoDegrees**(`value`): `number` -Defined in: [src/color/Color.ts:319](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L319) +Defined in: [src/color/Color.ts:319](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L319) Converts a string that could be any angle notation (50deg, 0.5turn, 2rad) into degrees without the 'deg' suffix @@ -408,7 +408,7 @@ number in degrees or NaN if inputs are invalid > `static` **sourceFromHex**(`color`): `undefined` \| [`TRGBAColorSource`](/api/type-aliases/trgbacolorsource/) -Defined in: [src/color/Color.ts:296](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L296) +Defined in: [src/color/Color.ts:296](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L296) Returns array representation (ex: [100, 100, 200, 1]) of a color that's in HEX format @@ -432,7 +432,7 @@ source > `static` **sourceFromHsl**(`color`): `undefined` \| [`TRGBAColorSource`](/api/type-aliases/trgbacolorsource/) -Defined in: [src/color/Color.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L251) +Defined in: [src/color/Color.ts:251](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L251) Returns array representation (ex: [100, 100, 200, 1]) of a color that's in HSL or HSLA format. Adapted from https://github.com/mjijackson @@ -461,7 +461,7 @@ http://http://www.w3.org/TR/css3-color/#hsl-color > `static` **sourceFromRgb**(`color`): `undefined` \| [`TRGBAColorSource`](/api/type-aliases/trgbacolorsource/) -Defined in: [src/color/Color.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/Color.ts#L213) +Defined in: [src/color/Color.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/Color.ts#L213) Returns array representation (ex: [100, 100, 200, 1]) of a color that's in RGB or RGBA format diff --git a/src/content/docs/api/classes/Control.md b/src/content/docs/api/classes/Control.md index b13555b1..396eaa74 100644 --- a/src/content/docs/api/classes/Control.md +++ b/src/content/docs/api/classes/Control.md @@ -5,7 +5,7 @@ prev: false title: "Control" --- -Defined in: [src/controls/Control.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L31) +Defined in: [src/controls/Control.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L31) ## Constructors @@ -13,7 +13,7 @@ Defined in: [src/controls/Control.ts:31](https://github.com/fabricjs/fabric.js/b > **new Control**(`options?`): `Control` -Defined in: [src/controls/Control.ts:157](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L157) +Defined in: [src/controls/Control.ts:157](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L157) #### Parameters @@ -31,7 +31,7 @@ Defined in: [src/controls/Control.ts:157](https://github.com/fabricjs/fabric.js/ > **actionHandler**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/) -Defined in: [src/controls/Control.ts:181](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L181) +Defined in: [src/controls/Control.ts:181](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L181) The control actionHandler, provide one to handle action ( control being moved ) @@ -61,7 +61,7 @@ true if the action/event modified the object > **actionName**: `string` = `SCALE` -Defined in: [src/controls/Control.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L53) +Defined in: [src/controls/Control.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L53) Name of the action that the control will likely execute. This is optional. FabricJS uses to identify what the user is doing for some @@ -83,7 +83,7 @@ default to scale since is the most common, used on 4 corners by default > **angle**: `number` = `0` -Defined in: [src/controls/Control.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L62) +Defined in: [src/controls/Control.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L62) Drawing angle of the control. NOT used for now, but name marked as needed for internal logic @@ -101,7 +101,7 @@ example: to reuse the same drawing function for different rotated controls > **cursorStyle**: `string` = `'crosshair'` -Defined in: [src/controls/Control.ts:142](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L142) +Defined in: [src/controls/Control.ts:142](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L142) Css cursor style to display when the control is hovered. if the method `cursorStyleHandler` is provided, this property is ignored. @@ -118,7 +118,7 @@ if the method `cursorStyleHandler` is provided, this property is ignored. > `optional` **mouseDownHandler**: [`ControlActionHandler`](/api/type-aliases/controlactionhandler/) -Defined in: [src/controls/Control.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L191) +Defined in: [src/controls/Control.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L191) The control handler for mouse down, provide one to handle mouse down on control @@ -148,7 +148,7 @@ true if the action/event modified the object > `optional` **mouseUpHandler**: [`ControlActionHandler`](/api/type-aliases/controlactionhandler/) -Defined in: [src/controls/Control.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L201) +Defined in: [src/controls/Control.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L201) The control mouseUpHandler, provide one to handle an effect on mouse up. @@ -178,7 +178,7 @@ true if the action/event modified the object > **offsetX**: `number` = `0` -Defined in: [src/controls/Control.ts:94](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L94) +Defined in: [src/controls/Control.ts:94](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L94) Horizontal offset of the control from the defined position. In pixels Positive offset moves the control to the right, negative to the left. @@ -201,7 +201,7 @@ of the bounding box. > **offsetY**: `number` = `0` -Defined in: [src/controls/Control.ts:102](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L102) +Defined in: [src/controls/Control.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L102) Vertical offset of the control from the defined position. In pixels Positive offset moves the control to the bottom, negative to the top. @@ -218,7 +218,7 @@ Positive offset moves the control to the bottom, negative to the top. > **sizeX**: `number` = `0` -Defined in: [src/controls/Control.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L110) +Defined in: [src/controls/Control.ts:110](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L110) Sets the length of the control. If null, defaults to object's cornerSize. Expects both sizeX and sizeY to be set when set. @@ -235,7 +235,7 @@ null > **sizeY**: `number` = `0` -Defined in: [src/controls/Control.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L118) +Defined in: [src/controls/Control.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L118) Sets the height of the control. If null, defaults to object's cornerSize. Expects both sizeX and sizeY to be set when set. @@ -252,7 +252,7 @@ null > **touchSizeX**: `number` = `0` -Defined in: [src/controls/Control.ts:126](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L126) +Defined in: [src/controls/Control.ts:126](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L126) Sets the length of the touch area of the control. If null, defaults to object's touchCornerSize. Expects both touchSizeX and touchSizeY to be set when set. @@ -269,7 +269,7 @@ null > **touchSizeY**: `number` = `0` -Defined in: [src/controls/Control.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L134) +Defined in: [src/controls/Control.ts:134](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L134) Sets the height of the touch area of the control. If null, defaults to object's touchCornerSize. Expects both touchSizeX and touchSizeY to be set when set. @@ -286,7 +286,7 @@ null > `optional` **transformAnchorPoint**: `object` -Defined in: [src/controls/Control.ts:152](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L152) +Defined in: [src/controls/Control.ts:152](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L152) #### x @@ -302,7 +302,7 @@ Defined in: [src/controls/Control.ts:152](https://github.com/fabricjs/fabric.js/ > **visible**: `boolean` = `true` -Defined in: [src/controls/Control.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L40) +Defined in: [src/controls/Control.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L40) keep track of control visibility. mainly for backward compatibility. @@ -321,7 +321,7 @@ true > **withConnection**: `boolean` = `false` -Defined in: [src/controls/Control.ts:150](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L150) +Defined in: [src/controls/Control.ts:150](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L150) If controls has an offsetY or offsetX, draw a line that connects the control to the bounding box @@ -338,7 +338,7 @@ false > **x**: `number` = `0` -Defined in: [src/controls/Control.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L71) +Defined in: [src/controls/Control.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L71) Relative position of the control. X 0,0 is the center of the Object, while -0.5 (left) or 0.5 (right) are the extremities @@ -356,7 +356,7 @@ of the bounding box. > **y**: `number` = `0` -Defined in: [src/controls/Control.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L80) +Defined in: [src/controls/Control.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L80) Relative position of the control. Y 0,0 is the center of the Object, while -0.5 (top) or 0.5 (bottom) are the extremities @@ -374,7 +374,7 @@ of the bounding box. > **calcCornerCoords**(`angle`, `objectCornerSize`, `centerX`, `centerY`, `isTouch`, `fabricObject`): `object` -Defined in: [src/controls/Control.ts:340](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L340) +Defined in: [src/controls/Control.ts:340](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L340) Returns the coords for this control based on object values. @@ -439,7 +439,7 @@ true if touch corner, false if normal corner > **commonRenderProps**(`ctx`, `left`, `top`, `fabricObject`, `styleOverride`): `object` -Defined in: [src/controls/Control.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L370) +Defined in: [src/controls/Control.ts:370](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L370) This is an helper method to prepare the canvas to render a control It detectes common control properties and sets the correct fill and @@ -498,7 +498,7 @@ rotations since different controls need differnt combination of these. > **cursorStyleHandler**(`eventData`, `control`, `fabricObject`, `coord`): `string` -Defined in: [src/controls/Control.ts:272](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L272) +Defined in: [src/controls/Control.ts:272](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L272) Returns control cursorStyle for css using cursorStyle. If you need a more elaborate function you can pass one in the constructor @@ -536,7 +536,7 @@ the current control ( likely this) > **getActionHandler**(`eventData`, `fabricObject`, `control`): `undefined` \| [`TransformActionHandler`](/api/type-aliases/transformactionhandler/) -Defined in: [src/controls/Control.ts:224](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L224) +Defined in: [src/controls/Control.ts:224](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L224) Returns control actionHandler @@ -572,7 +572,7 @@ the action handler > **getActionName**(`eventData`, `control`, `fabricObject`): `string` -Defined in: [src/controls/Control.ts:288](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L288) +Defined in: [src/controls/Control.ts:288](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L288) Returns the action name. The basic implementation just return the actionName property. @@ -604,7 +604,7 @@ the current control ( likely this) > **getMouseDownHandler**(`eventData`, `fabricObject`, `control`): `undefined` \| [`ControlActionHandler`](/api/type-aliases/controlactionhandler/) -Defined in: [src/controls/Control.ts:239](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L239) +Defined in: [src/controls/Control.ts:239](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L239) Returns control mouseDown handler @@ -640,7 +640,7 @@ the action handler > **getMouseUpHandler**(`eventData`, `fabricObject`, `control`): `undefined` \| [`ControlActionHandler`](/api/type-aliases/controlactionhandler/) -Defined in: [src/controls/Control.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L255) +Defined in: [src/controls/Control.ts:255](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L255) Returns control mouseUp handler. During actions the fabricObject or the control can be of different obj @@ -677,7 +677,7 @@ the action handler > **getTransformAnchorPoint**(): `object` -Defined in: [src/controls/Control.ts:161](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L161) +Defined in: [src/controls/Control.ts:161](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L161) #### Returns @@ -697,7 +697,7 @@ Defined in: [src/controls/Control.ts:161](https://github.com/fabricjs/fabric.js/ > **getVisibility**(`fabricObject`, `controlKey`): `boolean` -Defined in: [src/controls/Control.ts:302](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L302) +Defined in: [src/controls/Control.ts:302](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L302) Returns controls visibility @@ -723,7 +723,7 @@ key where the control is memorized on the > **positionHandler**(`dim`, `finalMatrix`, `fabricObject`, `currentControl`): [`Point`](/api/classes/point/) -Defined in: [src/controls/Control.ts:319](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L319) +Defined in: [src/controls/Control.ts:319](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L319) #### Parameters @@ -753,7 +753,7 @@ Defined in: [src/controls/Control.ts:319](https://github.com/fabricjs/fabric.js/ > **render**(`ctx`, `left`, `top`, `styleOverride`, `fabricObject`): `void` -Defined in: [src/controls/Control.ts:421](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L421) +Defined in: [src/controls/Control.ts:421](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L421) Render function for the control. When this function runs the context is unscaled. unrotate. Just retina scaled. @@ -801,7 +801,7 @@ the object where the control is about to be rendered > **setVisibility**(`visibility`, `name?`, `fabricObject?`): `void` -Defined in: [src/controls/Control.ts:311](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L311) +Defined in: [src/controls/Control.ts:311](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L311) Sets controls visibility @@ -831,7 +831,7 @@ for the object > **shouldActivate**(`controlKey`, `fabricObject`, `pointer`, `__namedParameters`): `boolean` -Defined in: [src/controls/Control.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/Control.ts#L203) +Defined in: [src/controls/Control.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/Control.ts#L203) #### Parameters diff --git a/src/content/docs/api/classes/Ellipse.md b/src/content/docs/api/classes/Ellipse.md index f0131b07..cb667ef0 100644 --- a/src/content/docs/api/classes/Ellipse.md +++ b/src/content/docs/api/classes/Ellipse.md @@ -5,7 +5,7 @@ prev: false title: "Ellipse" --- -Defined in: [src/shapes/Ellipse.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L29) +Defined in: [src/shapes/Ellipse.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L29) Exported so we can tweak default values @@ -37,7 +37,7 @@ Exported so we can tweak default values > **new Ellipse**\<`Props`, `SProps`, `EventSpec`\>(`options?`): `Ellipse`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Ellipse.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L66) +Defined in: [src/shapes/Ellipse.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L66) Constructor @@ -63,7 +63,7 @@ Options object > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -81,7 +81,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -97,7 +97,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -119,7 +119,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -148,7 +148,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -167,7 +167,7 @@ You can calculate them without updating with [()](/api/classes/ellipse/#calcacoo > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -191,7 +191,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -210,7 +210,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -234,7 +234,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -256,7 +256,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -280,7 +280,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -308,7 +308,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -334,7 +334,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -357,7 +357,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -378,7 +378,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -393,7 +393,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -408,7 +408,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -432,7 +432,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -460,7 +460,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -484,7 +484,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -512,7 +512,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -546,7 +546,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -567,7 +567,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -585,7 +585,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -607,7 +607,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -632,7 +632,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -658,7 +658,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -682,7 +682,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -706,7 +706,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -724,7 +724,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -742,7 +742,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -766,7 +766,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -784,7 +784,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -808,7 +808,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -826,7 +826,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -852,7 +852,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -867,7 +867,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -893,7 +893,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -911,7 +911,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -929,7 +929,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -947,7 +947,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -965,7 +965,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -983,7 +983,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -1001,7 +1001,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -1019,7 +1019,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -1037,7 +1037,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -1051,7 +1051,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -1075,7 +1075,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -1099,11 +1099,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1127,7 +1127,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1157,7 +1157,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1174,7 +1174,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1198,7 +1198,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1218,7 +1218,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1238,7 +1238,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1252,7 +1252,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1276,7 +1276,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1294,7 +1294,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1309,7 +1309,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1327,7 +1327,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **rx**: `number` -Defined in: [src/shapes/Ellipse.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L41) +Defined in: [src/shapes/Ellipse.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L41) Horizontal radius @@ -1341,7 +1341,7 @@ Horizontal radius > **ry**: `number` -Defined in: [src/shapes/Ellipse.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L47) +Defined in: [src/shapes/Ellipse.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L47) Vertical radius @@ -1355,7 +1355,7 @@ Vertical radius > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1379,7 +1379,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1403,7 +1403,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1422,7 +1422,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1445,7 +1445,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1469,7 +1469,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1493,7 +1493,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1517,7 +1517,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1535,7 +1535,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1554,7 +1554,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1579,7 +1579,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1603,7 +1603,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1627,7 +1627,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1651,7 +1651,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1669,7 +1669,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1693,7 +1693,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1730,7 +1730,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1754,7 +1754,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1780,7 +1780,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1804,7 +1804,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1828,7 +1828,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1846,7 +1846,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1864,7 +1864,7 @@ Object width > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Ellipse.ts:154](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L154) +Defined in: [src/shapes/Ellipse.ts:154](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L154) List of attribute names to account for when parsing SVG element (used by [Ellipse.fromElement](/api/classes/ellipse/#fromelement)) @@ -1878,7 +1878,7 @@ http://www.w3.org/TR/SVG/shapes.html#EllipseElement > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Ellipse.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L51) +Defined in: [src/shapes/Ellipse.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L51) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1895,7 +1895,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1909,7 +1909,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1924,7 +1924,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`Ellipse`\<`Partial`\<[`EllipseProps`](/api/interfaces/ellipseprops/)\>, [`SerializedEllipseProps`](/api/interfaces/serializedellipseprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `ellipseDefaultValues` -Defined in: [src/shapes/Ellipse.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L53) +Defined in: [src/shapes/Ellipse.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L53) #### Overrides @@ -1936,7 +1936,7 @@ Defined in: [src/shapes/Ellipse.ts:53](https://github.com/fabricjs/fabric.js/blo > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1952,7 +1952,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Ellipse'` -Defined in: [src/shapes/Ellipse.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L49) +Defined in: [src/shapes/Ellipse.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L49) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1975,7 +1975,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1998,7 +1998,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -2020,7 +2020,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -2052,7 +2052,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -2082,7 +2082,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -2100,7 +2100,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -2137,7 +2137,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -2159,7 +2159,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -2185,7 +2185,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -2211,7 +2211,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2238,7 +2238,7 @@ Rendering canvas context > **\_toSVG**(): `string`[] -Defined in: [src/shapes/Ellipse.ts:127](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L127) +Defined in: [src/shapes/Ellipse.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L127) Returns svg representation of an instance @@ -2259,7 +2259,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2281,7 +2281,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2328,7 +2328,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2347,7 +2347,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2368,7 +2368,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2389,7 +2389,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2419,7 +2419,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2445,7 +2445,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2481,7 +2481,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Ellipse`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2507,7 +2507,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2544,7 +2544,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1429) +Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1429) Returns complexity of an instance @@ -2564,7 +2564,7 @@ complexity of this instance (is 1 unless subclassed) > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2592,7 +2592,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2611,7 +2611,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2651,7 +2651,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2681,7 +2681,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2715,7 +2715,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2752,7 +2752,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2786,7 +2786,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2824,7 +2824,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2859,7 +2859,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2891,7 +2891,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2929,7 +2929,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2956,7 +2956,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2984,7 +2984,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -3000,7 +3000,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -3018,7 +3018,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -3039,7 +3039,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -3055,7 +3055,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -3073,7 +3073,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -3091,7 +3091,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -3109,7 +3109,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -3127,7 +3127,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/ellipse/#getpositionbyorigin) @@ -3159,7 +3159,7 @@ use [getPositionByOrigin](/api/classes/ellipse/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/ellipse/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -3197,7 +3197,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3215,7 +3215,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3234,7 +3234,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/ellip > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3252,7 +3252,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3271,7 +3271,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/ellip > **getRx**(): `number` -Defined in: [src/shapes/Ellipse.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L98) +Defined in: [src/shapes/Ellipse.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L98) Returns horizontal radius of an object (according to how an object is scaled) @@ -3285,7 +3285,7 @@ Returns horizontal radius of an object (according to how an object is scaled) > **getRy**(): `number` -Defined in: [src/shapes/Ellipse.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L106) +Defined in: [src/shapes/Ellipse.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L106) Returns Vertical radius of an object (according to how an object is scaled) @@ -3299,7 +3299,7 @@ Returns Vertical radius of an object (according to how an object is scaled) > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3323,7 +3323,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3347,7 +3347,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3371,7 +3371,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3395,7 +3395,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3425,7 +3425,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3457,7 +3457,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3475,7 +3475,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3495,7 +3495,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3513,7 +3513,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3531,7 +3531,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3549,7 +3549,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3567,7 +3567,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3595,7 +3595,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3624,7 +3624,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3653,7 +3653,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3681,7 +3681,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3709,7 +3709,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3739,7 +3739,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3767,7 +3767,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3795,7 +3795,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3824,7 +3824,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3849,7 +3849,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3881,7 +3881,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3899,7 +3899,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3920,7 +3920,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3948,7 +3948,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3968,7 +3968,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -4004,7 +4004,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -4030,7 +4030,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -4066,7 +4066,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -4102,7 +4102,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -4126,7 +4126,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -4146,7 +4146,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -4192,7 +4192,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4226,7 +4226,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4272,7 +4272,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4304,7 +4304,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4337,7 +4337,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4364,7 +4364,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4395,7 +4395,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4421,7 +4421,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4447,7 +4447,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4473,7 +4473,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4499,7 +4499,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4526,7 +4526,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4552,7 +4552,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4578,7 +4578,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4604,7 +4604,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4630,7 +4630,7 @@ New width value > **set**(`key`, `value?`): `Ellipse`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4662,7 +4662,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4689,7 +4689,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4727,7 +4727,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4746,7 +4746,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4767,7 +4767,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4805,7 +4805,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4830,7 +4830,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/ellipse > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/ellipse/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4868,7 +4868,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4893,7 +4893,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/ellip > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4917,7 +4917,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4963,7 +4963,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4987,7 +4987,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -5010,7 +5010,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -5037,7 +5037,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -5069,7 +5069,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -5091,7 +5091,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -5119,7 +5119,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -5151,7 +5151,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -5179,7 +5179,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -5207,7 +5207,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Ellipse`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -5233,7 +5233,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5253,7 +5253,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Ellipse.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L115) +Defined in: [src/shapes/Ellipse.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L115) Returns object representation of an instance @@ -5291,7 +5291,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -5309,7 +5309,7 @@ Returns a string representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5341,7 +5341,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5367,7 +5367,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5389,7 +5389,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5427,7 +5427,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5477,7 +5477,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5515,7 +5515,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5538,7 +5538,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5570,7 +5570,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5594,7 +5594,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<`Ellipse`\<`Record`\<`string`, `any`\>, [`SerializedEllipseProps`](/api/interfaces/serializedellipseprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Ellipse.ts:161](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L161) +Defined in: [src/shapes/Ellipse.ts:161](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L161) Returns [Ellipse](/api/classes/ellipse/) instance from an SVG element @@ -5624,7 +5624,7 @@ Element to parse > `static` **fromObject**\<`T`\>(`object`, `options?`): `Promise`\<[`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1931) +Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1931) #### Type Parameters @@ -5656,7 +5656,7 @@ Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabri > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Ellipse.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L55) +Defined in: [src/shapes/Ellipse.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L55) #### Returns diff --git a/src/content/docs/api/classes/FabricImage.md b/src/content/docs/api/classes/FabricImage.md index 426fb3d1..82528729 100644 --- a/src/content/docs/api/classes/FabricImage.md +++ b/src/content/docs/api/classes/FabricImage.md @@ -5,7 +5,7 @@ prev: false title: "FabricImage" --- -Defined in: [src/shapes/Image.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L89) +Defined in: [src/shapes/Image.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L89) ## See @@ -39,7 +39,7 @@ Defined in: [src/shapes/Image.ts:89](https://github.com/fabricjs/fabric.js/blob/ > **new FabricImage**\<`Props`, `SProps`, `EventSpec`\>(`elementId`, `options?`): `FabricImage`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Image.ts:205](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L205) +Defined in: [src/shapes/Image.ts:205](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L205) Constructor Image can be initialized with any canvas drawable or a string. @@ -71,7 +71,7 @@ Options object > **new FabricImage**\<`Props`, `SProps`, `EventSpec`\>(`element`, `options?`): `FabricImage`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Image.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L206) +Defined in: [src/shapes/Image.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L206) #### Parameters @@ -97,7 +97,7 @@ Defined in: [src/shapes/Image.ts:206](https://github.com/fabricjs/fabric.js/blob > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -115,7 +115,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -131,7 +131,7 @@ this takes priority over the generic control visibility > **\_element**: [`ImageSource`](/api/type-aliases/imagesource/) -Defined in: [src/shapes/Image.ts:180](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L180) +Defined in: [src/shapes/Image.ts:180](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L180) *** @@ -139,7 +139,7 @@ Defined in: [src/shapes/Image.ts:180](https://github.com/fabricjs/fabric.js/blob > `optional` **\_filteredEl**: `HTMLCanvasElement` -Defined in: [src/shapes/Image.ts:181](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L181) +Defined in: [src/shapes/Image.ts:181](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L181) *** @@ -147,7 +147,7 @@ Defined in: [src/shapes/Image.ts:181](https://github.com/fabricjs/fabric.js/blob > **\_originalElement**: [`ImageSource`](/api/type-aliases/imagesource/) -Defined in: [src/shapes/Image.ts:182](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L182) +Defined in: [src/shapes/Image.ts:182](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L182) *** @@ -155,7 +155,7 @@ Defined in: [src/shapes/Image.ts:182](https://github.com/fabricjs/fabric.js/blob > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -177,7 +177,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -206,7 +206,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -225,7 +225,7 @@ You can calculate them without updating with [()](/api/classes/fabricimage/#calc > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -249,7 +249,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -268,7 +268,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -292,7 +292,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -314,7 +314,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -338,7 +338,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -366,7 +366,7 @@ you will need to write your own render function for controls > **cacheKey**: `string` -Defined in: [src/shapes/Image.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L149) +Defined in: [src/shapes/Image.ts:149](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L149) key used to retrieve the texture representing this image @@ -380,7 +380,7 @@ key used to retrieve the texture representing this image > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -406,7 +406,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -429,7 +429,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -450,7 +450,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -465,7 +465,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -480,7 +480,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -504,7 +504,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -532,7 +532,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -556,7 +556,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -584,7 +584,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -618,7 +618,7 @@ This API is no longer supported and may be removed in a future release. > **cropX**: `number` -Defined in: [src/shapes/Image.ts:156](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L156) +Defined in: [src/shapes/Image.ts:156](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L156) Image crop in pixels from original image size. @@ -636,7 +636,7 @@ Image crop in pixels from original image size. > **cropY**: `number` -Defined in: [src/shapes/Image.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L163) +Defined in: [src/shapes/Image.ts:163](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L163) Image crop in pixels from original image size. @@ -654,7 +654,7 @@ Image crop in pixels from original image size. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -675,7 +675,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -693,7 +693,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -715,7 +715,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -740,7 +740,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -764,9 +764,9 @@ nonzero ### filters -> **filters**: [`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\>[] +> **filters**: [`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>[] -Defined in: [src/shapes/Image.ts:177](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L177) +Defined in: [src/shapes/Image.ts:177](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L177) #### Implementation of @@ -778,7 +778,7 @@ Defined in: [src/shapes/Image.ts:177](https://github.com/fabricjs/fabric.js/blob > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -802,7 +802,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -826,7 +826,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -844,7 +844,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -862,7 +862,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -886,7 +886,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -904,7 +904,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -928,7 +928,7 @@ null > **imageSmoothing**: `boolean` -Defined in: [src/shapes/Image.ts:171](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L171) +Defined in: [src/shapes/Image.ts:171](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L171) Indicates whether this canvas will use image smoothing when painting this image. Also influence if the cacheCanvas for this image uses imageSmoothing @@ -947,7 +947,7 @@ Also influence if the cacheCanvas for this image uses imageSmoothing > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -965,7 +965,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -991,7 +991,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -1006,7 +1006,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -1032,7 +1032,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -1050,7 +1050,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -1068,7 +1068,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -1086,7 +1086,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -1104,7 +1104,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -1122,7 +1122,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -1140,7 +1140,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -1158,7 +1158,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -1176,7 +1176,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -1190,7 +1190,7 @@ storage cache for object full transform matrix > **minimumScaleTrigger**: `number` -Defined in: [src/shapes/Image.ts:142](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L142) +Defined in: [src/shapes/Image.ts:142](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L142) minimum scale factor under which any resizeFilter is triggered to resize the image 0 will disable the automatic resize. 1 will trigger automatically always. @@ -1206,7 +1206,7 @@ number bigger than 1 are not implemented yet. > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -1230,7 +1230,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -1254,11 +1254,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1282,7 +1282,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1312,7 +1312,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1329,7 +1329,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1353,7 +1353,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1373,7 +1373,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1393,7 +1393,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1407,7 +1407,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1431,7 +1431,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1449,7 +1449,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1464,7 +1464,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1482,7 +1482,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **preserveAspectRatio**: `string` -Defined in: [src/shapes/Image.ts:173](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L173) +Defined in: [src/shapes/Image.ts:173](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L173) *** @@ -1490,7 +1490,7 @@ Defined in: [src/shapes/Image.ts:173](https://github.com/fabricjs/fabric.js/blob > **resizeFilter**: [`Resize`](/api/fabric/namespaces/filters/classes/resize/) -Defined in: [src/shapes/Image.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L178) +Defined in: [src/shapes/Image.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L178) #### Implementation of @@ -1502,7 +1502,7 @@ Defined in: [src/shapes/Image.ts:178](https://github.com/fabricjs/fabric.js/blob > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1526,7 +1526,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1550,7 +1550,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1569,7 +1569,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1592,7 +1592,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1616,7 +1616,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1640,7 +1640,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1664,7 +1664,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1682,7 +1682,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1701,7 +1701,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **srcFromAttribute**: `boolean` -Defined in: [src/shapes/Image.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L104) +Defined in: [src/shapes/Image.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L104) When calling [FabricImage.getSrc](/api/classes/fabricimage/#getsrc), return value from element src with `element.getAttribute('src')`. This allows for relative urls as image src. @@ -1726,7 +1726,7 @@ false > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1751,7 +1751,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1775,7 +1775,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1799,7 +1799,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1823,7 +1823,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1841,7 +1841,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1865,7 +1865,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1902,7 +1902,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1926,7 +1926,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1952,7 +1952,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1976,7 +1976,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -2000,7 +2000,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -2018,7 +2018,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -2036,7 +2036,7 @@ Object width > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Image.ts:774](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L774) +Defined in: [src/shapes/Image.ts:772](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L772) List of attribute names to account for when parsing SVG element (used by [FabricImage.fromElement](/api/classes/fabricimage/#fromelement)) @@ -2050,7 +2050,7 @@ List of attribute names to account for when parsing SVG element (used by [Fabric > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Image.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L186) +Defined in: [src/shapes/Image.ts:186](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L186) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -2067,7 +2067,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -2081,7 +2081,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -2096,7 +2096,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`FabricImage`\<`Partial`\<[`ImageProps`](/api/interfaces/imageprops/)\>, [`SerializedImageProps`](/api/interfaces/serializedimageprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `imageDefaultValues` -Defined in: [src/shapes/Image.ts:188](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L188) +Defined in: [src/shapes/Image.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L188) #### Overrides @@ -2108,7 +2108,7 @@ Defined in: [src/shapes/Image.ts:188](https://github.com/fabricjs/fabric.js/blob > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -2124,7 +2124,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Image'` -Defined in: [src/shapes/Image.ts:184](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L184) +Defined in: [src/shapes/Image.ts:184](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L184) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -2147,7 +2147,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -2170,7 +2170,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -2192,7 +2192,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -2224,7 +2224,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -2254,7 +2254,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -2272,7 +2272,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -2309,7 +2309,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -2331,7 +2331,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -2357,7 +2357,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -2383,7 +2383,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2410,7 +2410,7 @@ Rendering canvas context > **\_toSVG**(): `string`[] -Defined in: [src/shapes/Image.ts:372](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L372) +Defined in: [src/shapes/Image.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L372) Returns svg representation of an instance @@ -2431,7 +2431,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2453,7 +2453,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2500,7 +2500,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **applyFilters**(`filters`): `void` -Defined in: [src/shapes/Image.ts:531](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L531) +Defined in: [src/shapes/Image.ts:531](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L531) Applies filters assigned to this image (from "filters" array) or from filter param @@ -2508,7 +2508,7 @@ Applies filters assigned to this image (from "filters" array) or from filter par ##### filters -[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\>[] = `...` +[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>[] = `...` to be applied @@ -2522,7 +2522,7 @@ to be applied > **applyResizeFilters**(): `void` -Defined in: [src/shapes/Image.ts:492](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L492) +Defined in: [src/shapes/Image.ts:492](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L492) #### Returns @@ -2534,7 +2534,7 @@ Defined in: [src/shapes/Image.ts:492](https://github.com/fabricjs/fabric.js/blob > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2553,7 +2553,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2574,7 +2574,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2595,7 +2595,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2625,7 +2625,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2651,7 +2651,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2687,7 +2687,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`FabricImage`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2713,7 +2713,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): `FabricImage` -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2750,7 +2750,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1429) +Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1429) Returns complexity of an instance @@ -2770,7 +2770,7 @@ complexity of this instance (is 1 unless subclassed) > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2798,7 +2798,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Image.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L269) +Defined in: [src/shapes/Image.ts:269](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L269) Delete textures, reference to elements and eventually JSDOM cleanup @@ -2816,7 +2816,7 @@ Delete textures, reference to elements and eventually JSDOM cleanup > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2856,7 +2856,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Image.ts:613](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L613) +Defined in: [src/shapes/Image.ts:611](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L611) Paint the cached copy of the object on the target context. it will set the imageSmoothing for the draw operation @@ -2887,7 +2887,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2921,7 +2921,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2958,7 +2958,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2992,7 +2992,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -3030,7 +3030,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -3065,7 +3065,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -3097,7 +3097,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -3135,7 +3135,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -3162,7 +3162,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -3190,7 +3190,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -3206,7 +3206,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -3224,7 +3224,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -3245,7 +3245,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -3261,7 +3261,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -3279,7 +3279,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -3297,7 +3297,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getCrossOrigin**(): `null` \| `string` -Defined in: [src/shapes/Image.ts:287](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L287) +Defined in: [src/shapes/Image.ts:287](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L287) Get the crossOrigin value (of the corresponding image element) @@ -3311,7 +3311,7 @@ Get the crossOrigin value (of the corresponding image element) > **getElement**(): [`ImageSource`](/api/type-aliases/imagesource/) -Defined in: [src/shapes/Image.ts:227](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L227) +Defined in: [src/shapes/Image.ts:227](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L227) Returns image element which this instance if based on @@ -3325,7 +3325,7 @@ Returns image element which this instance if based on > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -3343,7 +3343,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -3361,7 +3361,7 @@ Return the object scale factor counting also the group scaling > **getOriginalSize**(): `object` -Defined in: [src/shapes/Image.ts:297](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L297) +Defined in: [src/shapes/Image.ts:297](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L297) Returns original size of an image @@ -3383,7 +3383,7 @@ Returns original size of an image > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/fabricimage/#getpositionbyorigin) @@ -3415,7 +3415,7 @@ use [getPositionByOrigin](/api/classes/fabricimage/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/fabricimage/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -3453,7 +3453,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3471,7 +3471,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3490,7 +3490,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/fabri > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3508,7 +3508,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3527,7 +3527,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/fabri > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3551,7 +3551,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3575,7 +3575,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSrc**(`filtered?`): `string` -Defined in: [src/shapes/Image.ts:442](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L442) +Defined in: [src/shapes/Image.ts:442](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L442) Returns source of an image @@ -3599,7 +3599,7 @@ Source of an image > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3623,7 +3623,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3647,7 +3647,7 @@ Returns filter for svg shadow > **getSvgSrc**(`filtered?`): `string` -Defined in: [src/shapes/Image.ts:464](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L464) +Defined in: [src/shapes/Image.ts:464](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L464) Alias for getSrc @@ -3671,7 +3671,7 @@ This API is no longer supported and may be removed in a future release. > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3701,7 +3701,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3733,7 +3733,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3751,7 +3751,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3771,7 +3771,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3789,7 +3789,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3807,7 +3807,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3825,7 +3825,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3843,7 +3843,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3871,7 +3871,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasCrop**(): `boolean` -Defined in: [src/shapes/Image.ts:358](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L358) +Defined in: [src/shapes/Image.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L358) Returns true if an image has crop applied, inspecting values of cropX,cropY,width,height. @@ -3885,7 +3885,7 @@ Returns true if an image has crop applied, inspecting values of cropX,cropY,widt > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3914,7 +3914,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3943,7 +3943,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3971,7 +3971,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3999,7 +3999,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -4029,7 +4029,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -4057,7 +4057,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -4085,7 +4085,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -4114,7 +4114,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -4139,7 +4139,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -4171,7 +4171,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -4189,7 +4189,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -4210,7 +4210,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -4238,7 +4238,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -4258,7 +4258,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -4294,7 +4294,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -4320,7 +4320,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -4356,7 +4356,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -4392,7 +4392,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -4416,7 +4416,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -4436,7 +4436,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -4482,7 +4482,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4516,7 +4516,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4562,7 +4562,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4594,7 +4594,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4627,7 +4627,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4654,7 +4654,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4685,7 +4685,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4711,7 +4711,7 @@ Places the left/top corner of the object bounding box in p. > **removeTexture**(`key`): `void` -Defined in: [src/shapes/Image.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L259) +Defined in: [src/shapes/Image.ts:259](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L259) Delete a single texture if in webgl mode @@ -4731,7 +4731,7 @@ Delete a single texture if in webgl mode > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4757,7 +4757,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4783,7 +4783,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4809,7 +4809,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4836,7 +4836,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4862,7 +4862,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4888,7 +4888,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4914,7 +4914,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4940,7 +4940,7 @@ New width value > **set**(`key`, `value?`): `FabricImage`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4972,7 +4972,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4999,7 +4999,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -5037,7 +5037,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -5056,7 +5056,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setElement**(`element`, `size?`): `void` -Defined in: [src/shapes/Image.ts:238](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L238) +Defined in: [src/shapes/Image.ts:238](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L238) Sets image element for this instance to a specified one. If filters defined they are applied to new image. @@ -5084,7 +5084,7 @@ Options object > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -5105,7 +5105,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -5143,7 +5143,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -5168,7 +5168,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/fabrici > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/fabricimage/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -5206,7 +5206,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -5231,7 +5231,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/fabri > **setSrc**(`src`, `options?`): `Promise`\<`void`\> -Defined in: [src/shapes/Image.ts:474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L474) +Defined in: [src/shapes/Image.ts:474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L474) Loads and sets source of an image\ **IMPORTANT**: It is recommended to abort loading tasks before calling this method to prevent race conditions and unnecessary networking @@ -5260,7 +5260,7 @@ Options object > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -5284,7 +5284,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -5330,7 +5330,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -5354,7 +5354,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Image.ts:632](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L632) +Defined in: [src/shapes/Image.ts:630](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L630) Decide if the FabricImage should cache or not. Create its own cache level needsItsOwnCache should be used when the object drawing method requires @@ -5379,7 +5379,7 @@ A full performance audit should be done. > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -5406,7 +5406,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -5438,7 +5438,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -5460,7 +5460,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -5488,7 +5488,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -5520,7 +5520,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -5548,7 +5548,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -5576,7 +5576,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `FabricImage`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -5602,7 +5602,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5622,7 +5622,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Image.ts:335](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L335) +Defined in: [src/shapes/Image.ts:335](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L335) Returns object representation of an instance @@ -5660,7 +5660,7 @@ Object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Image.ts:488](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L488) +Defined in: [src/shapes/Image.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L488) Returns string representation of an instance @@ -5680,7 +5680,7 @@ String representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5712,7 +5712,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5738,7 +5738,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5760,7 +5760,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5798,7 +5798,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5848,7 +5848,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5886,7 +5886,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5909,7 +5909,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5941,7 +5941,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5965,7 +5965,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<`null` \| `FabricImage`\<`Partial`\<[`ImageProps`](/api/interfaces/imageprops/)\>, [`SerializedImageProps`](/api/interfaces/serializedimageprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Image.ts:839](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L839) +Defined in: [src/shapes/Image.ts:837](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L837) Returns [FabricImage](/api/classes/fabricimage/) instance from an SVG element @@ -5997,7 +5997,7 @@ Options object > `static` **fromObject**\<`T`\>(`object`, `options?`): `Promise`\<`FabricImage`\<`Omit`\<`T`, `"type"` \| `"crossOrigin"` \| `"filters"` \| `"resizeFilter"` \| `"src"`\> & `object`, [`SerializedImageProps`](/api/interfaces/serializedimageprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Image.ts:794](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L794) +Defined in: [src/shapes/Image.ts:792](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L792) Creates an instance of FabricImage from its object representation @@ -6035,7 +6035,7 @@ Options object > `static` **fromURL**\<`T`\>(`url`, `__namedParameters?`, `imageOptions?`): `Promise`\<`FabricImage`\<`Partial`\<[`ImageProps`](/api/interfaces/imageprops/)\>, [`SerializedImageProps`](/api/interfaces/serializedimageprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Image.ts:822](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L822) +Defined in: [src/shapes/Image.ts:820](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L820) Creates an instance of Image from an URL string @@ -6071,7 +6071,7 @@ URL to create an image from > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Image.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L190) +Defined in: [src/shapes/Image.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L190) #### Returns diff --git a/src/content/docs/api/classes/FabricObject.md b/src/content/docs/api/classes/FabricObject.md index 91162816..10d5e604 100644 --- a/src/content/docs/api/classes/FabricObject.md +++ b/src/content/docs/api/classes/FabricObject.md @@ -5,7 +5,7 @@ prev: false title: "FabricObject" --- -Defined in: [src/shapes/Object/FabricObject.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObject.ts#L12) +Defined in: [src/shapes/Object/FabricObject.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObject.ts#L12) Exported so we can tweak default values @@ -44,7 +44,7 @@ Exported so we can tweak default values > **new FabricObject**\<`Props`, `SProps`, `EventSpec`\>(`options?`): `FabricObject`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L151) +Defined in: [src/shapes/Object/InteractiveObject.ts:154](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L154) Constructor @@ -70,7 +70,7 @@ Options object > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -88,7 +88,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -104,7 +104,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -126,7 +126,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -151,7 +151,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -170,7 +170,7 @@ You can calculate them without updating with [()](/api/classes/fabricobject/#cal > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -190,7 +190,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -205,7 +205,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -225,7 +225,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -243,7 +243,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -263,7 +263,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -287,7 +287,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -309,7 +309,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -328,7 +328,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -345,7 +345,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -360,7 +360,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -375,7 +375,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -395,7 +395,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -419,7 +419,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -439,7 +439,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -463,7 +463,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -493,7 +493,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -514,7 +514,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -528,7 +528,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -546,7 +546,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -567,7 +567,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -589,7 +589,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -609,7 +609,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -629,7 +629,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -643,7 +643,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -657,7 +657,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -677,7 +677,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -691,7 +691,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -711,7 +711,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -725,7 +725,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -747,7 +747,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -762,7 +762,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -784,7 +784,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -798,7 +798,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -812,7 +812,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -826,7 +826,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -840,7 +840,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -854,7 +854,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -868,7 +868,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -882,7 +882,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -896,7 +896,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -910,7 +910,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -930,7 +930,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -950,11 +950,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -974,7 +974,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1000,7 +1000,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1017,7 +1017,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1037,7 +1037,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1053,7 +1053,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1069,7 +1069,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1083,7 +1083,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1103,7 +1103,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1117,7 +1117,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1132,7 +1132,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1146,7 +1146,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1166,7 +1166,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1186,7 +1186,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1201,7 +1201,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1220,7 +1220,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1240,7 +1240,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1260,7 +1260,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1280,7 +1280,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1294,7 +1294,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1309,7 +1309,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1330,7 +1330,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1350,7 +1350,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1370,7 +1370,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1390,7 +1390,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1404,7 +1404,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1424,7 +1424,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1457,7 +1457,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1477,7 +1477,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1499,7 +1499,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1519,7 +1519,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1539,7 +1539,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1553,7 +1553,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1567,7 +1567,7 @@ Object width > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L234) +Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L234) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1584,7 +1584,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1598,7 +1598,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1613,7 +1613,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<[`InteractiveFabricObject`](/api/classes/interactivefabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `interactiveObjectDefaultValues` -Defined in: [src/shapes/Object/InteractiveObject.ts:138](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L138) +Defined in: [src/shapes/Object/InteractiveObject.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L141) #### Inherited from @@ -1625,7 +1625,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:138](https://github.com/fabr > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1641,7 +1641,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'FabricObject'` -Defined in: [src/shapes/Object/Object.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L343) +Defined in: [src/shapes/Object/Object.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L343) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1664,7 +1664,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1687,7 +1687,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1709,7 +1709,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -1741,7 +1741,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -1771,7 +1771,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -1789,7 +1789,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -1826,7 +1826,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -1848,7 +1848,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -1874,7 +1874,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -1900,7 +1900,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -1927,7 +1927,7 @@ Rendering canvas context > **\_toSVG**(`_reviver?`): `string`[] -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:126](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L126) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L136) Returns svg representation of an instance This function is implemented in each subclass @@ -1956,7 +1956,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -1978,7 +1978,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2025,7 +2025,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2044,7 +2044,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2065,7 +2065,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2086,7 +2086,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2116,7 +2116,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2142,7 +2142,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2178,7 +2178,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`FabricObject`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2204,7 +2204,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2241,7 +2241,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1429) +Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1429) Returns complexity of an instance @@ -2261,7 +2261,7 @@ complexity of this instance (is 1 unless subclassed) > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2289,7 +2289,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2308,7 +2308,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2348,7 +2348,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2378,7 +2378,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2412,7 +2412,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2449,7 +2449,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2483,7 +2483,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2521,7 +2521,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2556,7 +2556,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2588,7 +2588,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2626,7 +2626,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2653,7 +2653,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2681,7 +2681,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -2697,7 +2697,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -2715,7 +2715,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -2736,7 +2736,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -2752,7 +2752,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -2770,7 +2770,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -2788,7 +2788,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -2806,7 +2806,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -2824,7 +2824,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/fabricobject/#getpositionbyorigin) @@ -2856,7 +2856,7 @@ use [getPositionByOrigin](/api/classes/fabricobject/#getpositionbyorigin) instea > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/fabricobject/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -2894,7 +2894,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -2912,7 +2912,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -2931,7 +2931,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/fabri > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -2949,7 +2949,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -2968,7 +2968,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/fabri > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -2992,7 +2992,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3016,7 +3016,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3040,7 +3040,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3064,7 +3064,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3094,7 +3094,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3126,7 +3126,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3144,7 +3144,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3164,7 +3164,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3182,7 +3182,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3200,7 +3200,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3218,7 +3218,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3236,7 +3236,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3264,7 +3264,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3293,7 +3293,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3322,7 +3322,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3350,7 +3350,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3378,7 +3378,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3408,7 +3408,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3436,7 +3436,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3464,7 +3464,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3493,7 +3493,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3518,7 +3518,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3550,7 +3550,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3568,7 +3568,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3589,7 +3589,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3617,7 +3617,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3637,7 +3637,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -3673,7 +3673,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -3699,7 +3699,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -3735,7 +3735,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -3771,7 +3771,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -3795,7 +3795,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -3815,7 +3815,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -3861,7 +3861,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -3895,7 +3895,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -3941,7 +3941,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -3973,7 +3973,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4006,7 +4006,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4033,7 +4033,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4064,7 +4064,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4090,7 +4090,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4116,7 +4116,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4142,7 +4142,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4168,7 +4168,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4195,7 +4195,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4221,7 +4221,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4247,7 +4247,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4273,7 +4273,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4299,7 +4299,7 @@ New width value > **set**(`key`, `value?`): `FabricObject`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4331,7 +4331,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4358,7 +4358,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4396,7 +4396,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4415,7 +4415,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4436,7 +4436,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4474,7 +4474,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4499,7 +4499,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/fabrico > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/fabricobject/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4537,7 +4537,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4562,7 +4562,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/fabri > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4586,7 +4586,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4632,7 +4632,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4656,7 +4656,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -4679,7 +4679,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -4706,7 +4706,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -4738,7 +4738,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -4760,7 +4760,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -4788,7 +4788,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -4820,7 +4820,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -4848,7 +4848,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -4876,7 +4876,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `FabricObject`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -4902,7 +4902,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -4922,7 +4922,7 @@ JSON > **toObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1756) +Defined in: [src/shapes/Object/Object.ts:1756](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1756) Returns an object representation of an instance @@ -4950,7 +4950,7 @@ Object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -4968,7 +4968,7 @@ Returns a string representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5000,7 +5000,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5026,7 +5026,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5048,7 +5048,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5086,7 +5086,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5136,7 +5136,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5174,7 +5174,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5197,7 +5197,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5229,7 +5229,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5253,7 +5253,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromObject**\<`T`\>(`object`, `options?`): `Promise`\<[`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1931) +Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1931) #### Type Parameters @@ -5285,7 +5285,7 @@ Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabri > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L140) +Defined in: [src/shapes/Object/InteractiveObject.ts:143](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L143) #### Returns diff --git a/src/content/docs/api/classes/FabricText.md b/src/content/docs/api/classes/FabricText.md index eb5e7278..ec0a0b91 100644 --- a/src/content/docs/api/classes/FabricText.md +++ b/src/content/docs/api/classes/FabricText.md @@ -5,7 +5,7 @@ prev: false title: "FabricText" --- -Defined in: [src/shapes/Text/Text.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L140) +Defined in: [src/shapes/Text/Text.ts:142](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L142) Text class @@ -41,7 +41,7 @@ Text class > **new FabricText**\<`Props`, `SProps`, `EventSpec`\>(`text`, `options?`): `FabricText`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Text/Text.ts:430](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L430) +Defined in: [src/shapes/Text/Text.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L440) #### Parameters @@ -67,7 +67,7 @@ Defined in: [src/shapes/Text/Text.ts:430](https://github.com/fabricjs/fabric.js/ > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -85,7 +85,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_\_lineHeights**: `number`[] -Defined in: [src/shapes/Text/Text.ts:416](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L416) +Defined in: [src/shapes/Text/Text.ts:426](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L426) *** @@ -93,7 +93,7 @@ Defined in: [src/shapes/Text/Text.ts:416](https://github.com/fabricjs/fabric.js/ > **\_\_lineWidths**: `number`[] -Defined in: [src/shapes/Text/Text.ts:417](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L417) +Defined in: [src/shapes/Text/Text.ts:427](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L427) *** @@ -101,7 +101,7 @@ Defined in: [src/shapes/Text/Text.ts:417](https://github.com/fabricjs/fabric.js/ > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -117,7 +117,7 @@ this takes priority over the generic control visibility > **\_fontSizeMult**: `number` -Defined in: [src/shapes/Text/Text.ts:351](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L351) +Defined in: [src/shapes/Text/Text.ts:361](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L361) Text Line proportion to font Size (in pixels) @@ -127,7 +127,7 @@ Text Line proportion to font Size (in pixels) > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -149,7 +149,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **\_text**: `string`[] -Defined in: [src/shapes/Text/Text.ts:414](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L414) +Defined in: [src/shapes/Text/Text.ts:424](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L424) *** @@ -157,7 +157,7 @@ Defined in: [src/shapes/Text/Text.ts:414](https://github.com/fabricjs/fabric.js/ > **\_textLines**: `string`[][] -Defined in: [src/shapes/Text/Text.ts:411](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L411) +Defined in: [src/shapes/Text/Text.ts:421](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L421) same as textlines, but each line is an array of graphemes as split by splitByGrapheme @@ -171,7 +171,7 @@ same as textlines, but each line is an array of graphemes as split by splitByGra > **\_unwrappedTextLines**: `string`[][] -Defined in: [src/shapes/Text/Text.ts:413](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L413) +Defined in: [src/shapes/Text/Text.ts:423](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L423) *** @@ -179,7 +179,7 @@ Defined in: [src/shapes/Text/Text.ts:413](https://github.com/fabricjs/fabric.js/ > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -204,7 +204,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -223,7 +223,7 @@ You can calculate them without updating with [()](/api/classes/fabrictext/#calca > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -243,7 +243,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -258,7 +258,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -278,7 +278,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -296,7 +296,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -316,7 +316,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -340,7 +340,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -362,7 +362,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -381,7 +381,7 @@ when being scaled via the controls. > **charSpacing**: `number` -Defined in: [src/shapes/Text/Text.ts:358](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L358) +Defined in: [src/shapes/Text/Text.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L368) additional space between characters expressed in thousands of em unit @@ -396,7 +396,7 @@ expressed in thousands of em unit > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) #### Inherited from @@ -408,7 +408,7 @@ Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -423,7 +423,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -438,7 +438,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -458,7 +458,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -482,7 +482,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -502,7 +502,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -526,7 +526,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -556,7 +556,7 @@ This API is no longer supported and may be removed in a future release. > **cursorWidth**: `number` -Defined in: [src/shapes/Text/Text.ts:415](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L415) +Defined in: [src/shapes/Text/Text.ts:425](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L425) *** @@ -564,7 +564,7 @@ Defined in: [src/shapes/Text/Text.ts:415](https://github.com/fabricjs/fabric.js/ > **deltaY**: `number` -Defined in: [src/shapes/Text/Text.ts:364](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L364) +Defined in: [src/shapes/Text/Text.ts:374](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L374) Baseline shift, styles only, keep at 0 for the main text object @@ -574,7 +574,7 @@ Baseline shift, styles only, keep at 0 for the main text object > **direction**: `CanvasDirection` -Defined in: [src/shapes/Text/Text.ts:376](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L376) +Defined in: [src/shapes/Text/Text.ts:386](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L386) WARNING: EXPERIMENTAL. NOT SUPPORTED YET determine the direction of the text. @@ -597,7 +597,7 @@ https://www.w3.org/International/questions/qa-bidi-unicode-controls > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -618,7 +618,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -632,7 +632,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -650,7 +650,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) #### Inherited from @@ -662,7 +662,7 @@ Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -684,7 +684,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -704,7 +704,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -724,7 +724,7 @@ false > **fontFamily**: `string` -Defined in: [src/shapes/Text/Text.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L199) +Defined in: [src/shapes/Text/Text.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L201) Font family @@ -738,7 +738,7 @@ Font family > **fontSize**: `number` -Defined in: [src/shapes/Text/Text.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L187) +Defined in: [src/shapes/Text/Text.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L189) Font size (in pixels) @@ -752,7 +752,7 @@ Font size (in pixels) > **fontStyle**: `FontStyle` -Defined in: [src/shapes/Text/Text.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L230) +Defined in: [src/shapes/Text/Text.ts:232](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L232) Font style . Possible values: "", "normal", "italic" or "oblique". @@ -766,7 +766,7 @@ Font style . Possible values: "", "normal", "italic" or "oblique". > **fontWeight**: `string` \| `number` -Defined in: [src/shapes/Text/Text.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L193) +Defined in: [src/shapes/Text/Text.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L195) Font weight (e.g. bold, normal, 400, 600, 800) @@ -780,7 +780,7 @@ Font weight (e.g. bold, normal, 400, 600, 800) > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -794,7 +794,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -808,7 +808,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -828,7 +828,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -842,7 +842,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -862,7 +862,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -876,7 +876,7 @@ When `false`, default object's values are not included in its serialization > `optional` **initialized**: `true` -Defined in: [src/shapes/Text/Text.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L418) +Defined in: [src/shapes/Text/Text.ts:428](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L428) *** @@ -884,7 +884,7 @@ Defined in: [src/shapes/Text/Text.ts:418](https://github.com/fabricjs/fabric.js/ > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -906,7 +906,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -921,7 +921,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -943,7 +943,7 @@ You can change this by setting originX > **lineHeight**: `number` -Defined in: [src/shapes/Text/Text.ts:236](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L236) +Defined in: [src/shapes/Text/Text.ts:238](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L238) Line height @@ -957,7 +957,7 @@ Line height > **linethrough**: `boolean` -Defined in: [src/shapes/Text/Text.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L217) +Defined in: [src/shapes/Text/Text.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L219) Text decoration linethrough. @@ -971,7 +971,7 @@ Text decoration linethrough. > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -985,7 +985,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -999,7 +999,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -1013,7 +1013,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -1027,7 +1027,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -1041,7 +1041,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -1055,7 +1055,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -1069,7 +1069,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -1083,7 +1083,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -1097,7 +1097,7 @@ storage cache for object full transform matrix > **MIN\_TEXT\_WIDTH**: `number` -Defined in: [src/shapes/Text/Text.ts:398](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L398) +Defined in: [src/shapes/Text/Text.ts:408](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L408) contains the min text width to avoid getting 0 @@ -1107,7 +1107,7 @@ contains the min text width to avoid getting 0 > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -1127,7 +1127,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -1147,11 +1147,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1171,7 +1171,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1197,7 +1197,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1214,7 +1214,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1234,7 +1234,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1250,7 +1250,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1266,7 +1266,7 @@ please use 'center' as value in new projects > **overline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L211) +Defined in: [src/shapes/Text/Text.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L213) Text decoration overline. @@ -1280,7 +1280,7 @@ Text decoration overline. > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1294,7 +1294,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1314,7 +1314,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1328,7 +1328,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1343,7 +1343,7 @@ Used to keep the original parent ref when the object has been added to an Active > `optional` **path**: [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Text/Text.ts:299](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L299) +Defined in: [src/shapes/Text/Text.ts:301](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L301) Path that the text should follow. since 4.6.0 the path will be drawn automatically. @@ -1378,7 +1378,7 @@ const textPath = new Text('Text on a path', { > **pathAlign**: [`TPathAlign`](/api/type-aliases/tpathalign/) -Defined in: [src/shapes/Text/Text.ts:335](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L335) +Defined in: [src/shapes/Text/Text.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L345) How text is aligned to the path. This property determines the perpendicular position of each character relative to the path. @@ -1395,7 +1395,7 @@ This feature is in BETA, and its behavior may change > **pathSide**: [`TPathSide`](/api/type-aliases/tpathside/) -Defined in: [src/shapes/Text/Text.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L326) +Defined in: [src/shapes/Text/Text.ts:336](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L336) Which side of the path the text should be drawn on. Only used when text has a path @@ -1410,7 +1410,7 @@ Only used when text has a path > **pathStartOffset**: `number` -Defined in: [src/shapes/Text/Text.ts:319](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L319) +Defined in: [src/shapes/Text/Text.ts:329](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L329) Offset amount for text path starting position Only used when text has a path @@ -1421,7 +1421,7 @@ Only used when text has a path > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1435,7 +1435,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1455,7 +1455,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1475,7 +1475,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1490,7 +1490,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1509,7 +1509,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) #### Inherited from @@ -1521,7 +1521,7 @@ Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1541,7 +1541,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1561,7 +1561,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1575,7 +1575,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1590,7 +1590,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) #### Inherited from @@ -1602,7 +1602,7 @@ Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1622,7 +1622,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1642,7 +1642,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1662,7 +1662,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1676,7 +1676,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1696,7 +1696,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1729,7 +1729,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1749,7 +1749,7 @@ Width of a stroke used to render this object > **styles**: [`TextStyle`](/api/type-aliases/textstyle/) -Defined in: [src/shapes/Text/Text.ts:276](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L276) +Defined in: [src/shapes/Text/Text.ts:278](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L278) #### Overrides @@ -1761,7 +1761,7 @@ Defined in: [src/shapes/Text/Text.ts:276](https://github.com/fabricjs/fabric.js/ > **subscript**: `object` -Defined in: [src/shapes/Text/Text.ts:257](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L257) +Defined in: [src/shapes/Text/Text.ts:259](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L259) Subscript schema object (minimum overlap) @@ -1795,7 +1795,7 @@ fontSize factor > **superscript**: `object` -Defined in: [src/shapes/Text/Text.ts:241](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L241) +Defined in: [src/shapes/Text/Text.ts:243](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L243) Superscript schema object (minimum overlap) @@ -1829,7 +1829,7 @@ fontSize factor > **text**: `string` -Defined in: [src/shapes/Text/Text.ts:181](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L181) +Defined in: [src/shapes/Text/Text.ts:183](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L183) *** @@ -1837,7 +1837,7 @@ Defined in: [src/shapes/Text/Text.ts:181](https://github.com/fabricjs/fabric.js/ > **textAlign**: `TextAlign` -Defined in: [src/shapes/Text/Text.ts:224](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L224) +Defined in: [src/shapes/Text/Text.ts:226](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L226) Text alignment. Possible values: "left", "center", "right", "justify", "justify-left", "justify-center" or "justify-right". @@ -1852,23 +1852,40 @@ Text alignment. Possible values: "left", "center", "right", "justify", > **textBackgroundColor**: `string` -Defined in: [src/shapes/Text/Text.ts:274](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L274) +Defined in: [src/shapes/Text/Text.ts:276](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L276) Background color of text lines *** +### textDecorationColor? + +> `optional` **textDecorationColor**: `string` + +Defined in: [src/shapes/Text/Text.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L323) + +Optional text decoration color for underline, overline and strikethrough. +When undefined, decoration color falls back to the text fill color. +This feature is not really supported by anything else than svg 2 specs with css3 support. +Chrome does not support this, nor firefox apparently. + +#### Implementation of + +`UniqueTextProps.textDecorationColor` + +*** + ### textDecorationThickness > **textDecorationThickness**: `number` -Defined in: [src/shapes/Text/Text.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L313) +Defined in: [src/shapes/Text/Text.ts:315](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L315) -The text decoration tickness for underline, overline and strikethrough -The tickness is expressed in thousandths of fontSize ( em ). +The text decoration thickness for underline, overline and strikethrough +The thickness is expressed in thousandths of fontSize ( em ). The original value was 1/15 that translates to 66.6667 thousandths. The choice of unit of measure is to align with charSpacing. -You can slim the tickness without issues, while large underline or overline may end up +You can slim the thickness without issues, while large underline or overline may end up outside the bounding box of the text. In order to fix that a bigger refactor of the code is needed and is out of scope for now. If you need such large overline on the first line of text or large underline on the last line of text, consider disabling caching as a @@ -1890,7 +1907,7 @@ workaround > **textLines**: `string`[] -Defined in: [src/shapes/Text/Text.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L405) +Defined in: [src/shapes/Text/Text.ts:415](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L415) contains the the text of the object, divided in lines as they are displayed on screen. Wrapping will divide the text independently of line breaks @@ -1901,7 +1918,7 @@ on screen. Wrapping will divide the text independently of line breaks > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1923,7 +1940,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1943,7 +1960,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1963,7 +1980,7 @@ true > **underline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:205](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L205) +Defined in: [src/shapes/Text/Text.ts:207](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L207) Text decoration underline. @@ -1977,7 +1994,7 @@ Text decoration underline. > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1991,7 +2008,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -2005,7 +2022,7 @@ Object width > `static` **\_styleProperties**: readonly `StylePropertiesType`[] = `styleProperties` -Defined in: [src/shapes/Text/StyledText.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L30) +Defined in: [src/shapes/Text/StyledText.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L30) #### Inherited from @@ -2017,7 +2034,7 @@ Defined in: [src/shapes/Text/StyledText.ts:30](https://github.com/fabricjs/fabri > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Text/Text.ts:1840](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1840) +Defined in: [src/shapes/Text/Text.ts:1857](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1857) List of attribute names to account for when parsing SVG element (used by [FabricText.fromElement](/api/classes/fabrictext/#fromelement)) @see: http://www.w3.org/TR/SVG/text.html#TextElement @@ -2028,7 +2045,7 @@ List of attribute names to account for when parsing SVG element (used by [Fabric > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Text/Text.ts:420](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L420) +Defined in: [src/shapes/Text/Text.ts:430](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L430) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -2045,7 +2062,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -2059,7 +2076,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -2074,7 +2091,7 @@ instance.toObject() gets called > `static` **genericFonts**: `string`[] -Defined in: [src/shapes/Text/Text.ts:1818](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1818) +Defined in: [src/shapes/Text/Text.ts:1835](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1835) List of generic font families @@ -2088,7 +2105,7 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#generic-name > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`FabricText`\<`Partial`\<[`TextProps`](/api/interfaces/textprops/)\>, [`SerializedTextProps`](/api/interfaces/serializedtextprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `textDefaultValues` -Defined in: [src/shapes/Text/Text.ts:422](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L422) +Defined in: [src/shapes/Text/Text.ts:432](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L432) #### Overrides @@ -2100,7 +2117,7 @@ Defined in: [src/shapes/Text/Text.ts:422](https://github.com/fabricjs/fabric.js/ > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -2116,7 +2133,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Text'` -Defined in: [src/shapes/Text/Text.ts:424](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L424) +Defined in: [src/shapes/Text/Text.ts:434](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L434) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -2139,7 +2156,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -2162,7 +2179,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -2184,7 +2201,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -2216,7 +2233,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_getFontDeclaration**(`__namedParameters?`, `forMeasuring?`): `string` -Defined in: [src/shapes/Text/Text.ts:1677](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1677) +Defined in: [src/shapes/Text/Text.ts:1694](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1694) return font declaration string for canvas context @@ -2242,7 +2259,7 @@ font declaration formatted for canvas context. > **\_getGraphemeBox**(`grapheme`, `lineIndex`, `charIndex`, `prevGrapheme?`, `skipLeft?`): [`GraphemeBBox`](/api/type-aliases/graphemebbox/) -Defined in: [src/shapes/Text/Text.ts:979](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L979) +Defined in: [src/shapes/Text/Text.ts:989](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L989) #### Parameters @@ -2286,7 +2303,7 @@ grapheme bbox > **\_getWidthOfCharSpacing**(): `number` -Defined in: [src/shapes/Text/Text.ts:1526](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1526) +Defined in: [src/shapes/Text/Text.ts:1536](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1536) #### Returns @@ -2298,7 +2315,7 @@ Defined in: [src/shapes/Text/Text.ts:1526](https://github.com/fabricjs/fabric.js > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -2328,7 +2345,7 @@ dims > **\_measureLine**(`lineIndex`): `object` -Defined in: [src/shapes/Text/Text.ts:887](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L887) +Defined in: [src/shapes/Text/Text.ts:897](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L897) measure every grapheme of a line, populating __charBounds @@ -2358,7 +2375,7 @@ object.width total width of characters > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -2376,7 +2393,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -2413,7 +2430,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -2435,7 +2452,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `style`): `object` -Defined in: [src/shapes/Text/Text.ts:1343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1343) +Defined in: [src/shapes/Text/Text.ts:1353](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1353) This function prepare the canvas for a ill style, and fill need to be sent in as defined @@ -2474,7 +2491,7 @@ with ill defined > **\_setStrokeStyles**(`ctx`, `style`): `object` -Defined in: [src/shapes/Text/Text.ts:1321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1321) +Defined in: [src/shapes/Text/Text.ts:1331](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1331) This function prepare the canvas for a stroke style, and stroke and strokeWidth need to be sent in as defined @@ -2513,7 +2530,7 @@ with stroke and strokeWidth defined > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2540,7 +2557,7 @@ Rendering canvas context > **\_splitTextIntoLines**(`text`): `TextLinesInfo` -Defined in: [src/shapes/Text/Text.ts:1745](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1745) +Defined in: [src/shapes/Text/Text.ts:1762](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1762) Returns the text as an array of lines. @@ -2564,7 +2581,7 @@ Lines in the text > **\_toSVG**(`_reviver?`): `string`[] -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:126](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L126) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L136) Returns svg representation of an instance This function is implemented in each subclass @@ -2593,7 +2610,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2615,7 +2632,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2662,7 +2679,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2681,7 +2698,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2702,7 +2719,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2723,7 +2740,7 @@ transform matrix for the object > **calcTextHeight**(): `number` -Defined in: [src/shapes/Text/Text.ts:1051](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1051) +Defined in: [src/shapes/Text/Text.ts:1061](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1061) Calculate text box height @@ -2737,7 +2754,7 @@ Calculate text box height > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2767,7 +2784,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2793,7 +2810,7 @@ true if the object currently dragged can be dropped on the target > **cleanStyle**(`property`): `undefined` \| `false` -Defined in: [src/shapes/Text/StyledText.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L98) +Defined in: [src/shapes/Text/StyledText.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L98) Check if characters in a text have a value for a property whose value matches the textbox's value for that property. If so, @@ -2822,7 +2839,7 @@ then it also is deleted. > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2858,7 +2875,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`FabricText`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2884,7 +2901,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2921,7 +2938,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Text/Text.ts:1810](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1810) +Defined in: [src/shapes/Text/Text.ts:1827](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1827) Returns complexity of an instance @@ -2941,7 +2958,7 @@ complexity > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2969,7 +2986,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2988,7 +3005,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -3028,7 +3045,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -3058,7 +3075,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -3092,7 +3109,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -3129,7 +3146,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -3163,7 +3180,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -3201,7 +3218,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -3236,7 +3253,7 @@ it seemed a good option, now is an edge case > **enlargeSpaces**(): `void` -Defined in: [src/shapes/Text/Text.ts:496](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L496) +Defined in: [src/shapes/Text/Text.ts:506](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L506) Enlarge space boxes and shift the others @@ -3250,7 +3267,7 @@ Enlarge space boxes and shift the others > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -3282,7 +3299,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -3320,7 +3337,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -3347,7 +3364,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -3375,7 +3392,7 @@ value of a property > **get2DCursorLocation**(`selectionStart`, `skipWrapping?`): `object` -Defined in: [src/shapes/Text/Text.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L560) +Defined in: [src/shapes/Text/Text.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L570) Returns 2d representation (lineIndex and charIndex) of cursor @@ -3413,7 +3430,7 @@ consider the location for unwrapped lines. useful to manage styles. > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -3429,7 +3446,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -3447,7 +3464,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -3468,7 +3485,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -3484,7 +3501,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -3502,7 +3519,7 @@ Returns the center coordinates of the object relative to canvas > **getCompleteStyleDeclaration**(`lineIndex`, `charIndex`): [`CompleteTextStyleDeclaration`](/api/type-aliases/completetextstyledeclaration/) -Defined in: [src/shapes/Text/StyledText.ts:273](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L273) +Defined in: [src/shapes/Text/StyledText.ts:273](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L273) return a new object that contains all the style property for a character the object returned is newly created @@ -3537,7 +3554,7 @@ style object > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -3555,7 +3572,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getHeightOfChar**(`line`, `_char`): `number` -Defined in: [src/shapes/Text/Text.ts:862](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L862) +Defined in: [src/shapes/Text/Text.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L872) Computes height of character at given position @@ -3585,7 +3602,7 @@ fontSize of the character > **getHeightOfLine**(`lineIndex`): `number` -Defined in: [src/shapes/Text/Text.ts:1044](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1044) +Defined in: [src/shapes/Text/Text.ts:1054](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1054) Calculate height of line at 'lineIndex' @@ -3607,7 +3624,7 @@ index of line to calculate > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -3625,7 +3642,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -3643,7 +3660,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/fabrictext/#getpositionbyorigin) @@ -3675,7 +3692,7 @@ use [getPositionByOrigin](/api/classes/fabrictext/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/fabrictext/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -3713,7 +3730,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3731,7 +3748,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3750,7 +3767,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/fabri > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3768,7 +3785,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3787,7 +3804,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/fabri > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3811,7 +3828,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3835,7 +3852,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSelectionStyles**(`startIndex`, `endIndex?`, `complete?`): `Partial`\<[`CompleteTextStyleDeclaration`](/api/type-aliases/completetextstyledeclaration/)\>[] -Defined in: [src/shapes/Text/StyledText.ts:207](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L207) +Defined in: [src/shapes/Text/StyledText.ts:207](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L207) Gets style of a current selection/cursor (at the start position) @@ -3875,7 +3892,7 @@ styles an array with one, zero or more Style objects > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3899,7 +3916,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3923,7 +3940,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3953,7 +3970,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3985,7 +4002,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -4003,7 +4020,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -4023,7 +4040,7 @@ object with scaleX and scaleY properties > **getValueOfPropertyAt**\<`T`\>(`lineIndex`, `charIndex`, `property`): `FabricText`\<`Props`, `SProps`, `EventSpec`\>\[`T`\] -Defined in: [src/shapes/Text/Text.ts:1540](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1540) +Defined in: [src/shapes/Text/Text.ts:1550](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1550) Retrieves the value of property at given character position @@ -4065,7 +4082,7 @@ the value of 'property' > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -4083,7 +4100,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -4101,7 +4118,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -4119,7 +4136,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -4137,7 +4154,7 @@ y position according to object's originY property in canvas coordinate plane > **graphemeSplit**(`value`): `string`[] -Defined in: [src/shapes/Text/Text.ts:1736](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1736) +Defined in: [src/shapes/Text/Text.ts:1753](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1753) Override this method to customize grapheme splitting @@ -4165,7 +4182,7 @@ in the middle of the prototype chain > **handleFiller**\<`T`\>(`ctx`, `property`, `filler`): `object` -Defined in: [src/shapes/Text/Text.ts:1281](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1281) +Defined in: [src/shapes/Text/Text.ts:1291](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1291) #### Type Parameters @@ -4205,7 +4222,7 @@ Defined in: [src/shapes/Text/Text.ts:1281](https://github.com/fabricjs/fabric.js > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -4233,7 +4250,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -4262,7 +4279,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -4291,7 +4308,7 @@ Boolean > **initDimensions**(): `void` -Defined in: [src/shapes/Text/Text.ts:475](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L475) +Defined in: [src/shapes/Text/Text.ts:485](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L485) Initialize or update text dimensions. Updates this.width and this.height with the proper values. @@ -4307,7 +4324,7 @@ Does not return dimensions. > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -4335,7 +4352,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -4363,7 +4380,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -4393,7 +4410,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -4421,7 +4438,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -4449,7 +4466,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -4478,7 +4495,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -4503,7 +4520,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isEmptyStyles**(`lineIndex?`): `boolean` -Defined in: [src/shapes/Text/StyledText.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L41) +Defined in: [src/shapes/Text/StyledText.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L41) Returns true if object has no styling or no styling in a line @@ -4529,7 +4546,7 @@ Returns true if object has no styling or no styling in a line > **isEndOfWrapping**(`lineIndex`): `boolean` -Defined in: [src/shapes/Text/Text.ts:540](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L540) +Defined in: [src/shapes/Text/Text.ts:550](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L550) Detect if the text line is ended with an hard break text and itext do not have wrapping, return false @@ -4550,7 +4567,7 @@ text and itext do not have wrapping, return false > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -4582,7 +4599,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -4600,7 +4617,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -4621,7 +4638,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -4649,7 +4666,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -4669,7 +4686,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -4705,7 +4722,7 @@ A list of type strings to check against. > **measureLine**(`lineIndex`): `object` -Defined in: [src/shapes/Text/Text.ts:870](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L870) +Defined in: [src/shapes/Text/Text.ts:880](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L880) measure a text line measuring all characters. @@ -4735,7 +4752,7 @@ line number > **missingNewlineOffset**(`lineIndex`, `skipWrapping?`): `0` \| `1` -Defined in: [src/shapes/Text/Text.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L550) +Defined in: [src/shapes/Text/Text.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L560) Detect if a line has a linebreak and so we need to account for it when moving and counting style. @@ -4763,7 +4780,7 @@ Number > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -4789,7 +4806,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -4825,7 +4842,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -4861,7 +4878,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -4885,7 +4902,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -4905,7 +4922,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -4951,7 +4968,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4985,7 +5002,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -5031,7 +5048,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -5063,7 +5080,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -5096,7 +5113,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -5123,7 +5140,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -5154,7 +5171,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -5180,7 +5197,7 @@ Places the left/top corner of the object bounding box in p. > **removeStyle**(`property`): `void` -Defined in: [src/shapes/Text/StyledText.ts:159](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L159) +Defined in: [src/shapes/Text/StyledText.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L159) Remove a style property or properties from all individual character styles in a text object. Deletes the character style object if it contains no other style @@ -5206,7 +5223,7 @@ props. Deletes a line style object if it contains no other character styles. > **render**(`ctx`): `void` -Defined in: [src/shapes/Text/Text.ts:1710](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1710) +Defined in: [src/shapes/Text/Text.ts:1727](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1727) Renders text instance on a specified context @@ -5232,7 +5249,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -5258,7 +5275,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -5284,7 +5301,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -5311,7 +5328,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -5337,7 +5354,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -5363,7 +5380,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -5389,7 +5406,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -5415,7 +5432,7 @@ New width value > **set**(`key`, `value?`): `FabricText`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Text/Text.ts:1779](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1779) +Defined in: [src/shapes/Text/Text.ts:1796](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1796) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -5447,7 +5464,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -5474,7 +5491,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -5512,7 +5529,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -5531,7 +5548,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -5552,7 +5569,7 @@ Travis build error about unused variables. > **setPathInfo**(): `void` -Defined in: [src/shapes/Text/Text.ts:450](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L450) +Defined in: [src/shapes/Text/Text.ts:460](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L460) If text has a path, it will add the extra information needed for path and text calculations @@ -5567,7 +5584,7 @@ for path and text calculations > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -5605,7 +5622,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -5630,7 +5647,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/fabrict > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/fabrictext/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -5668,7 +5685,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -5693,7 +5710,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/fabri > **setSelectionStyles**(`styles`, `startIndex`, `endIndex?`): `void` -Defined in: [src/shapes/Text/StyledText.ts:239](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L239) +Defined in: [src/shapes/Text/StyledText.ts:239](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L239) Sets style of a current selection, if no selection exist, do not set anything. @@ -5731,7 +5748,7 @@ End index to get styles at, if not specified startIndex + 1 > **setSubscript**(`start`, `end`): `void` -Defined in: [src/shapes/Text/Text.ts:1422](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1422) +Defined in: [src/shapes/Text/Text.ts:1432](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1432) Turns the character into an 'inferior figure' (i.e. 'subscript') @@ -5759,7 +5776,7 @@ selection end > **setSuperscript**(`start`, `end`): `void` -Defined in: [src/shapes/Text/Text.ts:1413](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1413) +Defined in: [src/shapes/Text/Text.ts:1423](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1423) Turns the character into a 'superior figure' (i.e. 'superscript') @@ -5787,7 +5804,7 @@ selection end > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -5811,7 +5828,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -5857,7 +5874,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -5881,7 +5898,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -5904,7 +5921,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -5931,7 +5948,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -5963,7 +5980,7 @@ the control box size used > **styleHas**(`property`, `lineIndex?`): `boolean` -Defined in: [src/shapes/Text/StyledText.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L69) +Defined in: [src/shapes/Text/StyledText.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L69) Returns true if object has a style property or has it ina specified line This function is used to detect if a text will use a particular property or not. @@ -5996,7 +6013,7 @@ to check the style on > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -6018,7 +6035,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -6046,7 +6063,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -6078,7 +6095,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -6106,7 +6123,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -6134,7 +6151,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `FabricText`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -6160,7 +6177,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -6180,7 +6197,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Text/Text.ts:1768](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1768) +Defined in: [src/shapes/Text/Text.ts:1785](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1785) Returns object representation of an instance @@ -6218,7 +6235,7 @@ Object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Text/Text.ts:586](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L586) +Defined in: [src/shapes/Text/Text.ts:596](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L596) Returns string representation of an instance @@ -6238,7 +6255,7 @@ String representation of text object > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -6270,7 +6287,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -6296,7 +6313,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -6318,7 +6335,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -6356,7 +6373,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -6406,7 +6423,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -6444,7 +6461,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -6467,7 +6484,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -6499,7 +6516,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -6523,7 +6540,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<`FabricText`\<\{ `fontSize`: `number`; `left`: `number`; `linethrough`: `boolean`; `overline`: `boolean`; `signal?`: `AbortSignal`; `strokeWidth`: `number`; `top`: `number`; `underline`: `boolean`; \}, [`SerializedTextProps`](/api/interfaces/serializedtextprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Text/Text.ts:1859](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1859) +Defined in: [src/shapes/Text/Text.ts:1878](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1878) Returns FabricText instance from an SVG element (not yet implemented) @@ -6555,7 +6572,7 @@ Options object > `static` **fromObject**\<`T`, `S`\>(`object`): `Promise`\<`S`\> -Defined in: [src/shapes/Text/Text.ts:1934](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1934) +Defined in: [src/shapes/Text/Text.ts:1953](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1953) Returns FabricText instance from an object representation @@ -6591,7 +6608,7 @@ plain js Object to create an instance from > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Text/Text.ts:426](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L426) +Defined in: [src/shapes/Text/Text.ts:436](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L436) #### Returns diff --git a/src/content/docs/api/classes/FitContentLayout.md b/src/content/docs/api/classes/FitContentLayout.md index 2eca9b1e..18c6c62a 100644 --- a/src/content/docs/api/classes/FitContentLayout.md +++ b/src/content/docs/api/classes/FitContentLayout.md @@ -5,7 +5,7 @@ prev: false title: "FitContentLayout" --- -Defined in: [src/LayoutManager/LayoutStrategies/FitContentLayout.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/FitContentLayout.ts#L8) +Defined in: [src/LayoutManager/LayoutStrategies/FitContentLayout.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/FitContentLayout.ts#L8) Layout will adjust the bounding box to fit target's objects. @@ -33,7 +33,7 @@ Layout will adjust the bounding box to fit target's objects. > `readonly` `static` **type**: `"fit-content"` = `'fit-content'` -Defined in: [src/LayoutManager/LayoutStrategies/FitContentLayout.ts:9](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/FitContentLayout.ts#L9) +Defined in: [src/LayoutManager/LayoutStrategies/FitContentLayout.ts:9](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/FitContentLayout.ts#L9) override by subclass for persistence (TS does not support `static abstract`) @@ -47,7 +47,7 @@ override by subclass for persistence (TS does not support `static abstract`) > **calcBoundingBox**(`objects`, `context`): `undefined` \| [`LayoutStrategyResult`](/api/type-aliases/layoutstrategyresult/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L68) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L68) Override this method to customize layout. @@ -75,7 +75,7 @@ Override this method to customize layout. > **calcLayoutResult**(`context`, `objects`): `undefined` \| [`LayoutStrategyResult`](/api/type-aliases/layoutstrategyresult/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L33) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L33) Used by the `LayoutManager` to perform layout @TODO/fix: if this method is calcResult, should calc unconditionally. @@ -107,7 +107,7 @@ layout result **OR** `undefined` to skip layout > **getInitialSize**(`context`, `result`): [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L58) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L58) #### Parameters @@ -133,7 +133,7 @@ Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:58](https://gi > **shouldLayoutClipPath**(`__namedParameters`): `undefined` \| `boolean` -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L50) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L50) #### Parameters @@ -155,7 +155,7 @@ Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:50](https://gi > **shouldPerformLayout**(`context`): `boolean` -Defined in: [src/LayoutManager/LayoutStrategies/FitContentLayout.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/FitContentLayout.ts#L16) +Defined in: [src/LayoutManager/LayoutStrategies/FitContentLayout.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/FitContentLayout.ts#L16) layout on all triggers Override at will diff --git a/src/content/docs/api/classes/FixedLayout.md b/src/content/docs/api/classes/FixedLayout.md index 50ed2308..ef131393 100644 --- a/src/content/docs/api/classes/FixedLayout.md +++ b/src/content/docs/api/classes/FixedLayout.md @@ -5,7 +5,7 @@ prev: false title: "FixedLayout" --- -Defined in: [src/LayoutManager/LayoutStrategies/FixedLayout.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/FixedLayout.ts#L13) +Defined in: [src/LayoutManager/LayoutStrategies/FixedLayout.ts:13](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/FixedLayout.ts#L13) Layout will keep target's initial size. @@ -33,7 +33,7 @@ Layout will keep target's initial size. > `readonly` `static` **type**: `"fixed"` = `'fixed'` -Defined in: [src/LayoutManager/LayoutStrategies/FixedLayout.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/FixedLayout.ts#L14) +Defined in: [src/LayoutManager/LayoutStrategies/FixedLayout.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/FixedLayout.ts#L14) override by subclass for persistence (TS does not support `static abstract`) @@ -47,7 +47,7 @@ override by subclass for persistence (TS does not support `static abstract`) > **calcBoundingBox**(`objects`, `context`): `undefined` \| [`LayoutStrategyResult`](/api/type-aliases/layoutstrategyresult/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L68) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L68) Override this method to customize layout. @@ -75,7 +75,7 @@ Override this method to customize layout. > **calcLayoutResult**(`context`, `objects`): `undefined` \| [`LayoutStrategyResult`](/api/type-aliases/layoutstrategyresult/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L33) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L33) Used by the `LayoutManager` to perform layout @TODO/fix: if this method is calcResult, should calc unconditionally. @@ -107,7 +107,7 @@ layout result **OR** `undefined` to skip layout > **getInitialSize**(`__namedParameters`, `__namedParameters`): [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/LayoutStrategies/FixedLayout.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/FixedLayout.ts#L19) +Defined in: [src/LayoutManager/LayoutStrategies/FixedLayout.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/FixedLayout.ts#L19) respect target's initial size @@ -135,7 +135,7 @@ respect target's initial size > **shouldLayoutClipPath**(`__namedParameters`): `undefined` \| `boolean` -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L50) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L50) #### Parameters @@ -157,7 +157,7 @@ Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:50](https://gi > **shouldPerformLayout**(`__namedParameters`): `boolean` -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L42) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L42) #### Parameters diff --git a/src/content/docs/api/classes/Gradient.md b/src/content/docs/api/classes/Gradient.md index 70c9194f..71cdd8f9 100644 --- a/src/content/docs/api/classes/Gradient.md +++ b/src/content/docs/api/classes/Gradient.md @@ -5,7 +5,7 @@ prev: false title: "Gradient" --- -Defined in: [src/gradient/Gradient.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L30) +Defined in: [src/gradient/Gradient.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L32) Gradient class Gradient @@ -30,7 +30,7 @@ Gradient class > **new Gradient**\<`S`, `T`\>(`options`): `Gradient`\<`S`, `T`\> -Defined in: [src/gradient/Gradient.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L103) +Defined in: [src/gradient/Gradient.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L105) #### Parameters @@ -48,7 +48,7 @@ Defined in: [src/gradient/Gradient.ts:103](https://github.com/fabricjs/fabric.js > **colorStops**: [`ColorStop`](/api/type-aliases/colorstop/)[] -Defined in: [src/gradient/Gradient.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L87) +Defined in: [src/gradient/Gradient.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L89) Defines how many colors a gradient has and how they are located on the axis defined by coords @@ -59,7 +59,7 @@ defined by coords > **coords**: [`GradientCoords`](/api/type-aliases/gradientcoords/)\<`T`\> -Defined in: [src/gradient/Gradient.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L80) +Defined in: [src/gradient/Gradient.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L82) Defines how the gradient is located in space and spread @@ -69,7 +69,7 @@ Defines how the gradient is located in space and spread > `optional` **excludeFromExport**: `boolean` -Defined in: [src/gradient/Gradient.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L93) +Defined in: [src/gradient/Gradient.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L95) If true, this object will not be exported during the serialization of a canvas @@ -79,7 +79,7 @@ If true, this object will not be exported during the serialization of a canvas > `optional` **gradientTransform**: [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/gradient/Gradient.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L56) +Defined in: [src/gradient/Gradient.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L58) A transform matrix to apply to the gradient before painting. Imported from svg gradients, is not applied with the current transform in the center. @@ -98,7 +98,7 @@ null > **gradientUnits**: [`GradientUnits`](/api/type-aliases/gradientunits/) -Defined in: [src/gradient/Gradient.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L67) +Defined in: [src/gradient/Gradient.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L69) coordinates units for coords. If `pixels`, the number of coords are in the same unit of width / height. @@ -118,7 +118,7 @@ allowed values pixels or percentage. > `readonly` **id**: `string` \| `number` -Defined in: [src/gradient/Gradient.ts:99](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L99) +Defined in: [src/gradient/Gradient.ts:101](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L101) ID used for SVG export functionalities @@ -128,7 +128,7 @@ ID used for SVG export functionalities > **offsetX**: `number` -Defined in: [src/gradient/Gradient.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L39) +Defined in: [src/gradient/Gradient.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L41) Horizontal offset for aligning gradients coming from SVG when outside pathgroups @@ -144,7 +144,7 @@ Horizontal offset for aligning gradients coming from SVG when outside pathgroups > **offsetY**: `number` -Defined in: [src/gradient/Gradient.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L46) +Defined in: [src/gradient/Gradient.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L48) Vertical offset for aligning gradients coming from SVG when outside pathgroups @@ -160,7 +160,7 @@ Vertical offset for aligning gradients coming from SVG when outside pathgroups > **type**: `T` -Defined in: [src/gradient/Gradient.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L74) +Defined in: [src/gradient/Gradient.ts:76](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L76) Gradient type linear or radial @@ -176,7 +176,7 @@ Gradient type linear or radial > `static` **type**: `string` = `'Gradient'` -Defined in: [src/gradient/Gradient.ts:101](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L101) +Defined in: [src/gradient/Gradient.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L103) ## Methods @@ -184,7 +184,7 @@ Defined in: [src/gradient/Gradient.ts:101](https://github.com/fabricjs/fabric.js > **addColorStop**(`colorStops`): `Gradient`\<`S`, `T`\> -Defined in: [src/gradient/Gradient.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L134) +Defined in: [src/gradient/Gradient.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L136) Adds another colorStop @@ -206,7 +206,7 @@ thisArg > **toLive**(`ctx`): `CanvasGradient` -Defined in: [src/gradient/Gradient.ts:306](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L306) +Defined in: [src/gradient/Gradient.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L313) Returns an instance of CanvasGradient @@ -228,7 +228,7 @@ Context to render on > **toObject**(`propertiesToInclude?`): [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`T`\> -Defined in: [src/gradient/Gradient.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L149) +Defined in: [src/gradient/Gradient.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L151) Returns object representation of a gradient @@ -250,7 +250,7 @@ Any properties that you might want to additionally include in the output > **toSVG**(`object`, `__namedParameters`): `string` -Defined in: [src/gradient/Gradient.ts:172](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L172) +Defined in: [src/gradient/Gradient.ts:174](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L174) Returns SVG representation of an gradient @@ -280,7 +280,7 @@ SVG representation of an gradient (linear/radial) > `static` **fromElement**(`el`, `instance`, `svgOptions`): `Gradient`\<[`GradientType`](/api/type-aliases/gradienttype/)\> -Defined in: [src/gradient/Gradient.ts:382](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L382) +Defined in: [src/gradient/Gradient.ts:389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L389) Returns [Gradient](/api/classes/gradient/) instance from an SVG element @@ -354,7 +354,7 @@ Gradient instance > `static` **fromObject**(`options`): `Promise`\<`Gradient`\<`"linear"`, `"linear"`\>\> -Defined in: [src/gradient/Gradient.ts:320](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L320) +Defined in: [src/gradient/Gradient.ts:327](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L327) ##### Parameters @@ -370,7 +370,7 @@ Defined in: [src/gradient/Gradient.ts:320](https://github.com/fabricjs/fabric.js > `static` **fromObject**(`options`): `Promise`\<`Gradient`\<`"radial"`, `"radial"`\>\> -Defined in: [src/gradient/Gradient.ts:323](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/Gradient.ts#L323) +Defined in: [src/gradient/Gradient.ts:330](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/Gradient.ts#L330) ##### Parameters diff --git a/src/content/docs/api/classes/Group.md b/src/content/docs/api/classes/Group.md index 3f629fca..d8c9862d 100644 --- a/src/content/docs/api/classes/Group.md +++ b/src/content/docs/api/classes/Group.md @@ -5,7 +5,7 @@ prev: false title: "Group" --- -Defined in: [src/shapes/Group.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L82) +Defined in: [src/shapes/Group.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L82) ## Fires @@ -41,7 +41,7 @@ layout:after > **new Group**(`objects?`, `options?`): `Group` -Defined in: [src/shapes/Group.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L137) +Defined in: [src/shapes/Group.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L137) Constructor @@ -73,7 +73,7 @@ Options object > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -91,7 +91,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -107,7 +107,7 @@ this takes priority over the generic control visibility > **\_objects**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] = `[]` -Defined in: [src/Collection.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L21) +Defined in: [src/Collection.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L21) #### TODO @@ -123,7 +123,7 @@ needs to end up in the constructor too > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -145,7 +145,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -174,7 +174,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -193,7 +193,7 @@ You can calculate them without updating with [()](/api/classes/group/#calcacoord > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -217,7 +217,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -236,7 +236,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -260,7 +260,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -282,7 +282,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -306,7 +306,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -334,7 +334,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -360,7 +360,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -383,7 +383,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -404,7 +404,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -419,7 +419,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -434,7 +434,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -458,7 +458,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -486,7 +486,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -510,7 +510,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -538,7 +538,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -572,7 +572,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -593,7 +593,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -611,7 +611,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -633,7 +633,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -658,7 +658,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -684,7 +684,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -708,7 +708,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -732,7 +732,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -750,7 +750,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -768,7 +768,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -792,7 +792,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -810,7 +810,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -834,7 +834,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -852,7 +852,7 @@ When `false`, default object's values are not included in its serialization > **interactive**: `boolean` -Defined in: [src/shapes/Group.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L106) +Defined in: [src/shapes/Group.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L106) Used to allow targeting of object inside groups. set to true if you want to select an object inside a group.\ @@ -876,7 +876,7 @@ This API is no longer supported and may be removed in a future release. > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -902,7 +902,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -917,7 +917,7 @@ part of the move action. > **layoutManager**: [`LayoutManager`](/api/classes/layoutmanager/) -Defined in: [src/shapes/Group.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L108) +Defined in: [src/shapes/Group.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L108) #### Implementation of @@ -929,7 +929,7 @@ Defined in: [src/shapes/Group.ts:108](https://github.com/fabricjs/fabric.js/blob > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -955,7 +955,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -973,7 +973,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -991,7 +991,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -1009,7 +1009,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -1027,7 +1027,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -1045,7 +1045,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -1063,7 +1063,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -1081,7 +1081,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -1099,7 +1099,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -1113,7 +1113,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -1137,7 +1137,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -1161,11 +1161,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1189,7 +1189,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1219,7 +1219,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1236,7 +1236,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1260,7 +1260,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1280,7 +1280,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1300,7 +1300,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1314,7 +1314,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1338,7 +1338,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1356,7 +1356,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: `Group` -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1371,7 +1371,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1389,7 +1389,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1413,7 +1413,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1437,7 +1437,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1456,7 +1456,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1479,7 +1479,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1503,7 +1503,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1527,7 +1527,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1551,7 +1551,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1569,7 +1569,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1588,7 +1588,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1613,7 +1613,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1637,7 +1637,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1661,7 +1661,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1685,7 +1685,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1703,7 +1703,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1727,7 +1727,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1764,7 +1764,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1788,7 +1788,7 @@ Width of a stroke used to render this object > **subTargetCheck**: `boolean` -Defined in: [src/shapes/Group.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L93) +Defined in: [src/shapes/Group.ts:93](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L93) Used to optimize performance set to `false` if you don't need contained objects to be targets of events @@ -1803,7 +1803,7 @@ set to `false` if you don't need contained objects to be targets of events > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1829,7 +1829,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1853,7 +1853,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1877,7 +1877,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1895,7 +1895,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1913,7 +1913,7 @@ Object width > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L234) +Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L234) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1930,7 +1930,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1944,7 +1944,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1959,7 +1959,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Record`\<`string`, `any`\> = `groupDefaultValues` -Defined in: [src/shapes/Group.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L120) +Defined in: [src/shapes/Group.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L120) #### Overrides @@ -1971,7 +1971,7 @@ Defined in: [src/shapes/Group.ts:120](https://github.com/fabricjs/fabric.js/blob > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1987,7 +1987,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Group'` -Defined in: [src/shapes/Group.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L118) +Defined in: [src/shapes/Group.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L118) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -2014,7 +2014,7 @@ add sustainable warning message > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -2037,7 +2037,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -2059,7 +2059,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -2091,7 +2091,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -2121,7 +2121,7 @@ dims > **\_onObjectAdded**(`object`): `void` -Defined in: [src/shapes/Group.ts:256](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L256) +Defined in: [src/shapes/Group.ts:256](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L256) #### Parameters @@ -2143,7 +2143,7 @@ Defined in: [src/shapes/Group.ts:256](https://github.com/fabricjs/fabric.js/blob > **\_onStackOrderChanged**(): `void` -Defined in: [src/shapes/Group.ts:286](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L286) +Defined in: [src/shapes/Group.ts:286](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L286) #### Returns @@ -2159,7 +2159,7 @@ Defined in: [src/shapes/Group.ts:286](https://github.com/fabricjs/fabric.js/blob > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -2177,7 +2177,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -2214,7 +2214,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -2236,7 +2236,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -2262,7 +2262,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -2288,7 +2288,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2315,7 +2315,7 @@ Rendering canvas context > **\_toSVG**(`reviver?`): `string`[] -Defined in: [src/shapes/Group.ts:635](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L635) +Defined in: [src/shapes/Group.ts:635](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L635) Returns svg representation of an instance @@ -2343,7 +2343,7 @@ svg representation of an instance > **add**(...`objects`): `number` -Defined in: [src/shapes/Group.ts:226](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L226) +Defined in: [src/shapes/Group.ts:226](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L226) Add objects @@ -2367,7 +2367,7 @@ Add objects > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2389,7 +2389,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2436,7 +2436,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **bringObjectForward**(`object`, `intersecting?`): `boolean` -Defined in: [src/Collection.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L240) +Defined in: [src/Collection.ts:240](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L240) Moves an object or a selection up in stack of drawn objects An optional parameter, intersecting allows to move the object in front @@ -2474,7 +2474,7 @@ true if change occurred > **bringObjectToFront**(`object`): `boolean` -Defined in: [src/Collection.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L194) +Defined in: [src/Collection.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L194) Moves an object or the objects of a multiple selection to the top of the stack of drawn objects @@ -2503,7 +2503,7 @@ true if change occurred > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2522,7 +2522,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2543,7 +2543,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2564,7 +2564,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2594,7 +2594,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2620,7 +2620,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2656,7 +2656,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Group`\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2682,7 +2682,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2719,7 +2719,7 @@ fix the export type, it could not be Image but the type that getClass return for > **collectObjects**(`bbox`, `options`): [`InteractiveFabricObject`](/api/classes/interactivefabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/Collection.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L326) +Defined in: [src/Collection.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L326) Given a bounding box, return all the objects of the collection that are contained in the bounding box. If `includeIntersecting` is true, return also the objects that intersect the bounding box as well. @@ -2757,7 +2757,7 @@ array of objects contained in the bounding box, ordered from top to bottom stack > **complexity**(): `number` -Defined in: [src/Collection.ts:165](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L165) +Defined in: [src/Collection.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L165) #### Returns @@ -2775,7 +2775,7 @@ complexity > **contains**(`object`, `deep?`): `boolean` -Defined in: [src/Collection.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L148) +Defined in: [src/Collection.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L148) Returns true if collection contains an object.\ **Prefer using [FabricObject#isDescendantOf](/api/classes/fabricobject/#isdescendantof) for performance reasons** @@ -2811,7 +2811,7 @@ Object to check against > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2839,7 +2839,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Group.ts:603](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L603) +Defined in: [src/shapes/Group.ts:603](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L603) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2858,7 +2858,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2898,7 +2898,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2928,7 +2928,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2962,7 +2962,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2999,7 +2999,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -3033,7 +3033,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Group.ts:494](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L494) +Defined in: [src/shapes/Group.ts:494](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L494) Execute the drawing operation for an object on a specified context @@ -3067,7 +3067,7 @@ Context to render on > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -3102,7 +3102,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -3134,7 +3134,7 @@ an object that represent the ancestry situation. > **findNewLowerIndex**(`object`, `idx`, `intersecting?`): `number` -Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L272) +Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L272) #### Parameters @@ -3164,7 +3164,7 @@ Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/2 > **findNewUpperIndex**(`object`, `idx`, `intersecting?`): `number` -Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L295) +Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L295) #### Parameters @@ -3194,7 +3194,7 @@ Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/2 > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -3232,7 +3232,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -3259,7 +3259,7 @@ function to iterate over the controls over > **forEachObject**(`callback`): `void` -Defined in: [src/Collection.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L91) +Defined in: [src/Collection.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L91) Executes given function for each object in this group A simple shortcut for getObjects().forEach, before es6 was more complicated, @@ -3288,7 +3288,7 @@ Callback invoked with current object as first argument, > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -3316,7 +3316,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -3332,7 +3332,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -3350,7 +3350,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -3371,7 +3371,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -3387,7 +3387,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -3405,7 +3405,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -3423,7 +3423,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -3441,7 +3441,7 @@ Return the object opacity counting also the group property > **getObjects**(...`types?`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/Collection.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L108) +Defined in: [src/Collection.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L108) Returns an array of children objects of this instance @@ -3467,7 +3467,7 @@ When specified, only objects of these types are returned > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -3485,7 +3485,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/group/#getpositionbyorigin) @@ -3517,7 +3517,7 @@ use [getPositionByOrigin](/api/classes/group/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/group/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -3555,7 +3555,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3573,7 +3573,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3592,7 +3592,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/group > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3610,7 +3610,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3629,7 +3629,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/group > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3653,7 +3653,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3677,7 +3677,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3701,7 +3701,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3725,7 +3725,7 @@ Returns filter for svg shadow > **getSvgStyles**(): `string` -Defined in: [src/shapes/Group.ts:650](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L650) +Defined in: [src/shapes/Group.ts:650](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L650) Returns styles-string for svg-export, specific version for group @@ -3743,7 +3743,7 @@ Returns styles-string for svg-export, specific version for group > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3775,7 +3775,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3793,7 +3793,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3813,7 +3813,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3831,7 +3831,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3849,7 +3849,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3867,7 +3867,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3885,7 +3885,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3913,7 +3913,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3942,7 +3942,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3971,7 +3971,7 @@ Boolean > **insertAt**(`index`, ...`objects`): `number` -Defined in: [src/shapes/Group.ts:238](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L238) +Defined in: [src/shapes/Group.ts:238](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L238) Inserts an object into collection at specified index @@ -4003,7 +4003,7 @@ Object to insert > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -4031,7 +4031,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -4059,7 +4059,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -4089,7 +4089,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -4117,7 +4117,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -4145,7 +4145,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -4174,7 +4174,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -4199,7 +4199,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isEmpty**(): `boolean` -Defined in: [src/Collection.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L128) +Defined in: [src/Collection.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L128) Returns true if collection contains no objects @@ -4219,7 +4219,7 @@ true if collection is empty > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -4251,7 +4251,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -4269,7 +4269,7 @@ return if the object would be visible in rendering > **isOnACache**(): `boolean` -Defined in: [src/shapes/Group.ts:486](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L486) +Defined in: [src/shapes/Group.ts:486](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L486) Check if instance or its group are caching, recursively up @@ -4283,7 +4283,7 @@ Check if instance or its group are caching, recursively up > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -4304,7 +4304,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -4332,7 +4332,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -4352,7 +4352,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -4388,7 +4388,7 @@ A list of type strings to check against. > **item**(`index`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/Collection.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L120) +Defined in: [src/Collection.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L120) Returns object at specified index @@ -4414,7 +4414,7 @@ object at index > **moveObjectTo**(`object`, `index`): `boolean` -Defined in: [src/Collection.ts:262](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L262) +Defined in: [src/Collection.ts:262](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L262) Moves an object to specified level in stack of drawn objects @@ -4448,7 +4448,7 @@ true if change occurred > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -4474,7 +4474,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -4510,7 +4510,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -4546,7 +4546,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -4570,7 +4570,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -4590,7 +4590,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -4636,7 +4636,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4670,7 +4670,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4716,7 +4716,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4748,7 +4748,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4781,7 +4781,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4808,7 +4808,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4839,7 +4839,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4865,7 +4865,7 @@ Places the left/top corner of the object bounding box in p. > **remove**(...`objects`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/shapes/Group.ts:250](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L250) +Defined in: [src/shapes/Group.ts:250](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L250) Remove objects @@ -4891,7 +4891,7 @@ removed objects > **removeAll**(): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/shapes/Group.ts:317](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L317) +Defined in: [src/shapes/Group.ts:317](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L317) Remove all objects @@ -4907,7 +4907,7 @@ removed objects > **render**(`ctx`): `void` -Defined in: [src/shapes/Group.ts:537](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L537) +Defined in: [src/shapes/Group.ts:537](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L537) Renders instance on a given context @@ -4933,7 +4933,7 @@ context to render instance on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4959,7 +4959,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4985,7 +4985,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -5012,7 +5012,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -5038,7 +5038,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -5064,7 +5064,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -5090,7 +5090,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -5116,7 +5116,7 @@ New width value > **sendObjectBackwards**(`object`, `intersecting?`): `boolean` -Defined in: [src/Collection.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L214) +Defined in: [src/Collection.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L214) Moves an object or a selection down in stack of drawn objects An optional parameter, `intersecting` allows to move the object in behind @@ -5154,7 +5154,7 @@ true if change occurred > **sendObjectToBack**(`object`): `boolean` -Defined in: [src/Collection.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L178) +Defined in: [src/Collection.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L178) Moves an object or the objects of a multiple selection to the bottom of the stack of drawn objects @@ -5183,7 +5183,7 @@ true if change occurred > **set**(`key`, `value?`): `Group` -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -5215,7 +5215,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -5242,7 +5242,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -5280,7 +5280,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Group.ts:519](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L519) +Defined in: [src/shapes/Group.ts:519](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L519) #### Returns @@ -5296,7 +5296,7 @@ Defined in: [src/shapes/Group.ts:519](https://github.com/fabricjs/fabric.js/blob > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -5317,7 +5317,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -5355,7 +5355,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -5380,7 +5380,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/group/# > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/group/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -5418,7 +5418,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -5443,7 +5443,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/group > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -5467,7 +5467,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -5513,7 +5513,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -5537,7 +5537,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Group.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L453) +Defined in: [src/shapes/Group.ts:453](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L453) Decide if the group should cache or not. Create its own cache level needsItsOwnCache should be used when the object drawing method requires @@ -5558,7 +5558,7 @@ Generally you do not cache objects in groups because the group is already cached > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -5585,7 +5585,7 @@ true in order for the window to start a drag session > **size**(): `number` -Defined in: [src/Collection.ts:136](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L136) +Defined in: [src/Collection.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L136) Returns a size of a collection (i.e: length of an array containing its objects) @@ -5605,7 +5605,7 @@ Collection size > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -5637,7 +5637,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -5659,7 +5659,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -5687,7 +5687,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`reviver?`): `string` -Defined in: [src/shapes/Group.ts:664](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L664) +Defined in: [src/shapes/Group.ts:664](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L664) Returns svg clipPath representation of an instance @@ -5715,7 +5715,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -5743,7 +5743,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -5771,7 +5771,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Group` -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -5797,7 +5797,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5817,7 +5817,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & [`SerializedGroupProps`](/api/interfaces/serializedgroupprops/) -Defined in: [src/shapes/Group.ts:574](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L574) +Defined in: [src/shapes/Group.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L574) Returns object representation of an instance @@ -5855,7 +5855,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Group.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L599) +Defined in: [src/shapes/Group.ts:599](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L599) Returns a string representation of an instance @@ -5873,7 +5873,7 @@ Returns a string representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5905,7 +5905,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5931,7 +5931,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5953,7 +5953,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5991,7 +5991,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -6041,7 +6041,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -6079,7 +6079,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **triggerLayout**(`options`): `void` -Defined in: [src/shapes/Group.ts:525](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L525) +Defined in: [src/shapes/Group.ts:525](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L525) #### Parameters @@ -6097,7 +6097,7 @@ Defined in: [src/shapes/Group.ts:525](https://github.com/fabricjs/fabric.js/blob > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Group.ts:470](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L470) +Defined in: [src/shapes/Group.ts:470](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L470) Check if this object or a child object will cast a shadow @@ -6115,7 +6115,7 @@ Check if this object or a child object will cast a shadow > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -6147,7 +6147,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -6171,7 +6171,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Group.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L124) +Defined in: [src/shapes/Group.ts:124](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L124) #### Returns diff --git a/src/content/docs/api/classes/IText.md b/src/content/docs/api/classes/IText.md index 7fb3cb00..f614343a 100644 --- a/src/content/docs/api/classes/IText.md +++ b/src/content/docs/api/classes/IText.md @@ -5,7 +5,7 @@ prev: false title: "IText" --- -Defined in: [src/shapes/IText/IText.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L122) +Defined in: [src/shapes/IText/IText.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L122) ## Fires @@ -110,7 +110,7 @@ paste > **new IText**\<`Props`, `SProps`, `EventSpec`\>(`text`, `options?`): `IText`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/IText/IText.ts:224](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L224) +Defined in: [src/shapes/IText/IText.ts:224](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L224) Constructor @@ -142,7 +142,7 @@ Options object > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -160,7 +160,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_\_lineHeights**: `number`[] -Defined in: [src/shapes/Text/Text.ts:416](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L416) +Defined in: [src/shapes/Text/Text.ts:426](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L426) #### Inherited from @@ -172,7 +172,7 @@ Defined in: [src/shapes/Text/Text.ts:416](https://github.com/fabricjs/fabric.js/ > **\_\_lineWidths**: `number`[] -Defined in: [src/shapes/Text/Text.ts:417](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L417) +Defined in: [src/shapes/Text/Text.ts:427](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L427) #### Inherited from @@ -184,7 +184,7 @@ Defined in: [src/shapes/Text/Text.ts:417](https://github.com/fabricjs/fabric.js/ > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -200,7 +200,7 @@ this takes priority over the generic control visibility > **\_fontSizeMult**: `number` -Defined in: [src/shapes/Text/Text.ts:351](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L351) +Defined in: [src/shapes/Text/Text.ts:361](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L361) Text Line proportion to font Size (in pixels) @@ -214,7 +214,7 @@ Text Line proportion to font Size (in pixels) > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -236,7 +236,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **\_text**: `string`[] -Defined in: [src/shapes/Text/Text.ts:414](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L414) +Defined in: [src/shapes/Text/Text.ts:424](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L424) #### Inherited from @@ -248,7 +248,7 @@ Defined in: [src/shapes/Text/Text.ts:414](https://github.com/fabricjs/fabric.js/ > **\_textLines**: `string`[][] -Defined in: [src/shapes/Text/Text.ts:411](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L411) +Defined in: [src/shapes/Text/Text.ts:421](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L421) same as textlines, but each line is an array of graphemes as split by splitByGrapheme @@ -262,7 +262,7 @@ same as textlines, but each line is an array of graphemes as split by splitByGra > **\_unwrappedTextLines**: `string`[][] -Defined in: [src/shapes/Text/Text.ts:413](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L413) +Defined in: [src/shapes/Text/Text.ts:423](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L423) #### Inherited from @@ -274,7 +274,7 @@ Defined in: [src/shapes/Text/Text.ts:413](https://github.com/fabricjs/fabric.js/ > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -299,7 +299,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -318,7 +318,7 @@ You can calculate them without updating with [()](/api/classes/itext/#calcacoord > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -338,7 +338,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -353,7 +353,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -373,7 +373,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -391,7 +391,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -411,7 +411,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -435,7 +435,7 @@ you will need to write your own render function for controls > **caching**: `boolean` -Defined in: [src/shapes/IText/IText.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L203) +Defined in: [src/shapes/IText/IText.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L203) Indicates whether internal text char widths can be cached @@ -445,7 +445,7 @@ Indicates whether internal text char widths can be cached > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -467,7 +467,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -486,7 +486,7 @@ when being scaled via the controls. > **charSpacing**: `number` -Defined in: [src/shapes/Text/Text.ts:358](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L358) +Defined in: [src/shapes/Text/Text.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L368) additional space between characters expressed in thousands of em unit @@ -501,7 +501,7 @@ expressed in thousands of em unit > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) #### Inherited from @@ -513,7 +513,7 @@ Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -528,7 +528,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **compositionColor**: `string` -Defined in: [src/shapes/IText/IText.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L197) +Defined in: [src/shapes/IText/IText.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L197) *** @@ -536,7 +536,7 @@ Defined in: [src/shapes/IText/IText.ts:197](https://github.com/fabricjs/fabric.j > **compositionEnd**: `number` -Defined in: [src/shapes/IText/IText.ts:144](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L144) +Defined in: [src/shapes/IText/IText.ts:144](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L144) #### Overrides @@ -548,7 +548,7 @@ Defined in: [src/shapes/IText/IText.ts:144](https://github.com/fabricjs/fabric.j > **compositionStart**: `number` -Defined in: [src/shapes/IText/IText.ts:142](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L142) +Defined in: [src/shapes/IText/IText.ts:142](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L142) #### Overrides @@ -560,7 +560,7 @@ Defined in: [src/shapes/IText/IText.ts:142](https://github.com/fabricjs/fabric.j > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -575,7 +575,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -595,7 +595,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -619,7 +619,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -639,7 +639,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -663,7 +663,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -693,7 +693,7 @@ This API is no longer supported and may be removed in a future release. > **ctrlKeysMapDown**: `TKeyMapIText` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L42) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L42) For functionalities on keyDown + ctrl || cmd @@ -707,7 +707,7 @@ For functionalities on keyDown + ctrl || cmd > **ctrlKeysMapUp**: `TKeyMapIText` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L37) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L37) For functionalities on keyUp + ctrl || cmd @@ -721,7 +721,7 @@ For functionalities on keyUp + ctrl || cmd > **cursorColor**: `string` -Defined in: [src/shapes/IText/IText.ts:183](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L183) +Defined in: [src/shapes/IText/IText.ts:183](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L183) Color of text cursor color in editing mode. if not set (default) will take color from the text. @@ -734,7 +734,7 @@ be used instead of the color of the text at the current position. > **cursorDelay**: `number` -Defined in: [src/shapes/IText/IText.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L189) +Defined in: [src/shapes/IText/IText.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L189) Delay between cursor blink (in ms) @@ -748,7 +748,7 @@ Delay between cursor blink (in ms) > **cursorDuration**: `number` -Defined in: [src/shapes/IText/IText.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L195) +Defined in: [src/shapes/IText/IText.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L195) Duration of cursor fade in (in ms) @@ -762,7 +762,7 @@ Duration of cursor fade in (in ms) > **cursorWidth**: `number` -Defined in: [src/shapes/IText/IText.ts:174](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L174) +Defined in: [src/shapes/IText/IText.ts:174](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L174) Width of cursor (in px) @@ -776,7 +776,7 @@ Width of cursor (in px) > **deltaY**: `number` -Defined in: [src/shapes/Text/Text.ts:364](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L364) +Defined in: [src/shapes/Text/Text.ts:374](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L374) Baseline shift, styles only, keep at 0 for the main text object @@ -790,7 +790,7 @@ Baseline shift, styles only, keep at 0 for the main text object > **direction**: `CanvasDirection` -Defined in: [src/shapes/Text/Text.ts:376](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L376) +Defined in: [src/shapes/Text/Text.ts:386](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L386) WARNING: EXPERIMENTAL. NOT SUPPORTED YET determine the direction of the text. @@ -813,7 +813,7 @@ https://www.w3.org/International/questions/qa-bidi-unicode-controls > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -834,7 +834,7 @@ true > **editable**: `boolean` -Defined in: [src/shapes/IText/IText.ts:162](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L162) +Defined in: [src/shapes/IText/IText.ts:162](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L162) Indicates whether a text can be edited @@ -848,7 +848,7 @@ Indicates whether a text can be edited > **editingBorderColor**: `string` -Defined in: [src/shapes/IText/IText.ts:168](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L168) +Defined in: [src/shapes/IText/IText.ts:168](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L168) Border color of text object while it's in editing mode @@ -862,7 +862,7 @@ Border color of text object while it's in editing mode > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -876,7 +876,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -894,7 +894,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) #### Inherited from @@ -906,7 +906,7 @@ Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -928,7 +928,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -948,7 +948,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -968,7 +968,7 @@ false > **fontFamily**: `string` -Defined in: [src/shapes/Text/Text.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L199) +Defined in: [src/shapes/Text/Text.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L201) Font family @@ -982,7 +982,7 @@ Font family > **fontSize**: `number` -Defined in: [src/shapes/Text/Text.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L187) +Defined in: [src/shapes/Text/Text.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L189) Font size (in pixels) @@ -996,7 +996,7 @@ Font size (in pixels) > **fontStyle**: `FontStyle` -Defined in: [src/shapes/Text/Text.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L230) +Defined in: [src/shapes/Text/Text.ts:232](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L232) Font style . Possible values: "", "normal", "italic" or "oblique". @@ -1010,7 +1010,7 @@ Font style . Possible values: "", "normal", "italic" or "oblique". > **fontWeight**: `string` \| `number` -Defined in: [src/shapes/Text/Text.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L193) +Defined in: [src/shapes/Text/Text.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L195) Font weight (e.g. bold, normal, 400, 600, 800) @@ -1024,7 +1024,7 @@ Font weight (e.g. bold, normal, 400, 600, 800) > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -1038,7 +1038,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -1052,7 +1052,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -1072,7 +1072,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -1086,7 +1086,7 @@ Object height > **hiddenTextarea**: `null` \| `HTMLTextAreaElement` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:44](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L44) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:44](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L44) #### Inherited from @@ -1098,7 +1098,7 @@ Defined in: [src/shapes/IText/ITextKeyBehavior.ts:44](https://github.com/fabricj > `optional` **hiddenTextareaContainer**: `null` \| `HTMLElement` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L53) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L53) DOM container to append the hiddenTextarea. An alternative to attaching to the document.body. @@ -1115,7 +1115,7 @@ also with modals event capturing that won't let the textarea take focus. > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -1135,7 +1135,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -1149,7 +1149,7 @@ When `false`, default object's values are not included in its serialization > `optional` **initialized**: `true` -Defined in: [src/shapes/Text/Text.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L418) +Defined in: [src/shapes/Text/Text.ts:428](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L428) #### Inherited from @@ -1161,7 +1161,7 @@ Defined in: [src/shapes/Text/Text.ts:418](https://github.com/fabricjs/fabric.js/ > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -1183,7 +1183,7 @@ false > **isEditing**: `boolean` -Defined in: [src/shapes/IText/IText.ts:156](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L156) +Defined in: [src/shapes/IText/IText.ts:156](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L156) Indicates whether text is in editing mode @@ -1197,7 +1197,7 @@ Indicates whether text is in editing mode > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -1212,7 +1212,7 @@ part of the move action. > **keysMap**: `TKeyMapIText` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L30) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L30) For functionalities on keyDown Map a special key to a function of the instance/prototype @@ -1234,7 +1234,7 @@ The function must be in IText.prototype.myFunction And will receive event as arg > **keysMapRtl**: `TKeyMapIText` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L32) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L32) #### Inherited from @@ -1246,7 +1246,7 @@ Defined in: [src/shapes/IText/ITextKeyBehavior.ts:32](https://github.com/fabricj > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -1268,7 +1268,7 @@ You can change this by setting originX > **lineHeight**: `number` -Defined in: [src/shapes/Text/Text.ts:236](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L236) +Defined in: [src/shapes/Text/Text.ts:238](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L238) Line height @@ -1282,7 +1282,7 @@ Line height > **linethrough**: `boolean` -Defined in: [src/shapes/Text/Text.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L217) +Defined in: [src/shapes/Text/Text.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L219) Text decoration linethrough. @@ -1296,7 +1296,7 @@ Text decoration linethrough. > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -1310,7 +1310,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -1324,7 +1324,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -1338,7 +1338,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -1352,7 +1352,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -1366,7 +1366,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -1380,7 +1380,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -1394,7 +1394,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -1408,7 +1408,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -1422,7 +1422,7 @@ storage cache for object full transform matrix > **MIN\_TEXT\_WIDTH**: `number` -Defined in: [src/shapes/Text/Text.ts:398](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L398) +Defined in: [src/shapes/Text/Text.ts:408](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L408) contains the min text width to avoid getting 0 @@ -1436,7 +1436,7 @@ contains the min text width to avoid getting 0 > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -1456,7 +1456,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -1476,11 +1476,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1500,7 +1500,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1526,7 +1526,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1543,7 +1543,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1563,7 +1563,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1579,7 +1579,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1595,7 +1595,7 @@ please use 'center' as value in new projects > **overline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L211) +Defined in: [src/shapes/Text/Text.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L213) Text decoration overline. @@ -1609,7 +1609,7 @@ Text decoration overline. > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1623,7 +1623,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1643,7 +1643,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1657,7 +1657,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1672,7 +1672,7 @@ Used to keep the original parent ref when the object has been added to an Active > `optional` **path**: [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Text/Text.ts:299](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L299) +Defined in: [src/shapes/Text/Text.ts:301](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L301) Path that the text should follow. since 4.6.0 the path will be drawn automatically. @@ -1707,7 +1707,7 @@ const textPath = new Text('Text on a path', { > **pathAlign**: [`TPathAlign`](/api/type-aliases/tpathalign/) -Defined in: [src/shapes/Text/Text.ts:335](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L335) +Defined in: [src/shapes/Text/Text.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L345) How text is aligned to the path. This property determines the perpendicular position of each character relative to the path. @@ -1724,7 +1724,7 @@ This feature is in BETA, and its behavior may change > **pathSide**: [`TPathSide`](/api/type-aliases/tpathside/) -Defined in: [src/shapes/Text/Text.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L326) +Defined in: [src/shapes/Text/Text.ts:336](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L336) Which side of the path the text should be drawn on. Only used when text has a path @@ -1739,7 +1739,7 @@ Only used when text has a path > **pathStartOffset**: `number` -Defined in: [src/shapes/Text/Text.ts:319](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L319) +Defined in: [src/shapes/Text/Text.ts:329](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L329) Offset amount for text path starting position Only used when text has a path @@ -1754,7 +1754,7 @@ Only used when text has a path > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1768,7 +1768,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1788,7 +1788,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1808,7 +1808,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1823,7 +1823,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1842,7 +1842,7 @@ This API is no longer supported and may be removed in a future release. > **selectionColor**: `string` -Defined in: [src/shapes/IText/IText.ts:150](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L150) +Defined in: [src/shapes/IText/IText.ts:150](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L150) Color of text selection @@ -1852,7 +1852,7 @@ Color of text selection > **selectionEnd**: `number` -Defined in: [src/shapes/IText/IText.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L140) +Defined in: [src/shapes/IText/IText.ts:140](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L140) Index where text selection ends @@ -1870,7 +1870,7 @@ Index where text selection ends > **selectionStart**: `number` -Defined in: [src/shapes/IText/IText.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L134) +Defined in: [src/shapes/IText/IText.ts:134](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L134) Index where text selection starts (or where cursor is when there is no selection) @@ -1888,7 +1888,7 @@ Index where text selection starts (or where cursor is when there is no selection > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) #### Inherited from @@ -1900,7 +1900,7 @@ Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1920,7 +1920,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1940,7 +1940,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1954,7 +1954,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1969,7 +1969,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) #### Inherited from @@ -1981,7 +1981,7 @@ Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -2001,7 +2001,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -2021,7 +2021,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -2041,7 +2041,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -2055,7 +2055,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -2075,7 +2075,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -2108,7 +2108,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -2128,7 +2128,7 @@ Width of a stroke used to render this object > **styles**: [`TextStyle`](/api/type-aliases/textstyle/) -Defined in: [src/shapes/Text/Text.ts:276](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L276) +Defined in: [src/shapes/Text/Text.ts:278](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L278) #### Inherited from @@ -2140,7 +2140,7 @@ Defined in: [src/shapes/Text/Text.ts:276](https://github.com/fabricjs/fabric.js/ > **subscript**: `object` -Defined in: [src/shapes/Text/Text.ts:257](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L257) +Defined in: [src/shapes/Text/Text.ts:259](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L259) Subscript schema object (minimum overlap) @@ -2178,7 +2178,7 @@ fontSize factor > **superscript**: `object` -Defined in: [src/shapes/Text/Text.ts:241](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L241) +Defined in: [src/shapes/Text/Text.ts:243](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L243) Superscript schema object (minimum overlap) @@ -2216,7 +2216,7 @@ fontSize factor > **text**: `string` -Defined in: [src/shapes/Text/Text.ts:181](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L181) +Defined in: [src/shapes/Text/Text.ts:183](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L183) #### Inherited from @@ -2228,7 +2228,7 @@ Defined in: [src/shapes/Text/Text.ts:181](https://github.com/fabricjs/fabric.js/ > **textAlign**: `TextAlign` -Defined in: [src/shapes/Text/Text.ts:224](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L224) +Defined in: [src/shapes/Text/Text.ts:226](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L226) Text alignment. Possible values: "left", "center", "right", "justify", "justify-left", "justify-center" or "justify-right". @@ -2243,7 +2243,7 @@ Text alignment. Possible values: "left", "center", "right", "justify", > **textBackgroundColor**: `string` -Defined in: [src/shapes/Text/Text.ts:274](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L274) +Defined in: [src/shapes/Text/Text.ts:276](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L276) Background color of text lines @@ -2253,17 +2253,34 @@ Background color of text lines *** +### textDecorationColor? + +> `optional` **textDecorationColor**: `string` + +Defined in: [src/shapes/Text/Text.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L323) + +Optional text decoration color for underline, overline and strikethrough. +When undefined, decoration color falls back to the text fill color. +This feature is not really supported by anything else than svg 2 specs with css3 support. +Chrome does not support this, nor firefox apparently. + +#### Inherited from + +`ITextClickBehavior.textDecorationColor` + +*** + ### textDecorationThickness > **textDecorationThickness**: `number` -Defined in: [src/shapes/Text/Text.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L313) +Defined in: [src/shapes/Text/Text.ts:315](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L315) -The text decoration tickness for underline, overline and strikethrough -The tickness is expressed in thousandths of fontSize ( em ). +The text decoration thickness for underline, overline and strikethrough +The thickness is expressed in thousandths of fontSize ( em ). The original value was 1/15 that translates to 66.6667 thousandths. The choice of unit of measure is to align with charSpacing. -You can slim the tickness without issues, while large underline or overline may end up +You can slim the thickness without issues, while large underline or overline may end up outside the bounding box of the text. In order to fix that a bigger refactor of the code is needed and is out of scope for now. If you need such large overline on the first line of text or large underline on the last line of text, consider disabling caching as a @@ -2285,7 +2302,7 @@ workaround > **textLines**: `string`[] -Defined in: [src/shapes/Text/Text.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L405) +Defined in: [src/shapes/Text/Text.ts:415](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L415) contains the the text of the object, divided in lines as they are displayed on screen. Wrapping will divide the text independently of line breaks @@ -2300,7 +2317,7 @@ on screen. Wrapping will divide the text independently of line breaks > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -2322,7 +2339,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -2342,7 +2359,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -2362,7 +2379,7 @@ true > **underline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:205](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L205) +Defined in: [src/shapes/Text/Text.ts:207](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L207) Text decoration underline. @@ -2376,7 +2393,7 @@ Text decoration underline. > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -2390,7 +2407,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -2404,7 +2421,7 @@ Object width > `static` **\_styleProperties**: readonly `StylePropertiesType`[] = `styleProperties` -Defined in: [src/shapes/Text/StyledText.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L30) +Defined in: [src/shapes/Text/StyledText.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L30) #### Inherited from @@ -2416,7 +2433,7 @@ Defined in: [src/shapes/Text/StyledText.ts:30](https://github.com/fabricjs/fabri > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Text/Text.ts:1840](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1840) +Defined in: [src/shapes/Text/Text.ts:1857](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1857) List of attribute names to account for when parsing SVG element (used by [FabricText.fromElement](/api/classes/fabrictext/#fromelement)) @see: http://www.w3.org/TR/SVG/text.html#TextElement @@ -2431,7 +2448,7 @@ List of attribute names to account for when parsing SVG element (used by [Fabric > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Text/Text.ts:420](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L420) +Defined in: [src/shapes/Text/Text.ts:430](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L430) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -2448,7 +2465,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -2462,7 +2479,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -2477,7 +2494,7 @@ instance.toObject() gets called > `static` **genericFonts**: `string`[] -Defined in: [src/shapes/Text/Text.ts:1818](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1818) +Defined in: [src/shapes/Text/Text.ts:1835](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1835) List of generic font families @@ -2495,7 +2512,7 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#generic-name > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`IText`\<`Partial`\<[`ITextProps`](/api/interfaces/itextprops/)\>, [`SerializedITextProps`](/api/interfaces/serializeditextprops/), [`ITextEvents`](/api/type-aliases/itextevents/)\>\>\> = `iTextDefaultValues` -Defined in: [src/shapes/IText/IText.ts:205](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L205) +Defined in: [src/shapes/IText/IText.ts:205](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L205) #### Overrides @@ -2507,7 +2524,7 @@ Defined in: [src/shapes/IText/IText.ts:205](https://github.com/fabricjs/fabric.j > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -2523,7 +2540,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'IText'` -Defined in: [src/shapes/IText/IText.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L211) +Defined in: [src/shapes/IText/IText.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L211) #### Overrides @@ -2537,7 +2554,7 @@ Defined in: [src/shapes/IText/IText.ts:211](https://github.com/fabricjs/fabric.j > **get** **type**(): `string` -Defined in: [src/shapes/IText/IText.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L213) +Defined in: [src/shapes/IText/IText.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L213) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -2566,7 +2583,7 @@ This API is no longer supported and may be removed in a future release. > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -2598,7 +2615,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_getFontDeclaration**(`__namedParameters?`, `forMeasuring?`): `string` -Defined in: [src/shapes/Text/Text.ts:1677](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1677) +Defined in: [src/shapes/Text/Text.ts:1694](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1694) return font declaration string for canvas context @@ -2628,7 +2645,7 @@ font declaration formatted for canvas context. > **\_getGraphemeBox**(`grapheme`, `lineIndex`, `charIndex`, `prevGrapheme?`, `skipLeft?`): [`GraphemeBBox`](/api/type-aliases/graphemebbox/) -Defined in: [src/shapes/Text/Text.ts:979](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L979) +Defined in: [src/shapes/Text/Text.ts:989](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L989) #### Parameters @@ -2676,7 +2693,7 @@ grapheme bbox > **\_getSelectionForOffset**(`e`, `isRight`): `number` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:383](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L383) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L383) private Helps finding if the offset should be counted from Start or End @@ -2707,7 +2724,7 @@ Event object > **\_getWidthOfCharSpacing**(): `number` -Defined in: [src/shapes/Text/Text.ts:1526](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1526) +Defined in: [src/shapes/Text/Text.ts:1536](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1536) #### Returns @@ -2723,7 +2740,7 @@ Defined in: [src/shapes/Text/Text.ts:1526](https://github.com/fabricjs/fabric.js > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -2753,7 +2770,7 @@ dims > **\_measureLine**(`lineIndex`): `object` -Defined in: [src/shapes/Text/Text.ts:887](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L887) +Defined in: [src/shapes/Text/Text.ts:897](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L897) measure every grapheme of a line, populating __charBounds @@ -2787,7 +2804,7 @@ object.width total width of characters > **\_mouseDownHandler**(`__namedParameters`): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L98) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L98) Default event handler for the basic functionalities needed on _mouseDown can be overridden to do something different. @@ -2816,7 +2833,7 @@ current compositionMode. It will be set to false. > **\_moveCursorLeftOrRight**(`direction`, `e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:645](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L645) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:645](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L645) Moves cursor right or Left, fires event @@ -2848,7 +2865,7 @@ Event object > **\_moveCursorUpOrDown**(`direction`, `e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L483) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L483) Moves cursor up or down, fires the events @@ -2880,7 +2897,7 @@ Event object > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -2898,7 +2915,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -2935,7 +2952,7 @@ move to interactivity > **\_renderCursor**(`ctx`, `boundaries`, `selectionStart`): `void` -Defined in: [src/shapes/IText/IText.ts:601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L601) +Defined in: [src/shapes/IText/IText.ts:601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L601) Render the cursor at the given selectionStart. @@ -2965,7 +2982,7 @@ transformed context to draw on > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -2987,7 +3004,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `style`): `object` -Defined in: [src/shapes/Text/Text.ts:1343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1343) +Defined in: [src/shapes/Text/Text.ts:1353](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1353) This function prepare the canvas for a ill style, and fill need to be sent in as defined @@ -3026,7 +3043,7 @@ with ill defined > **\_setStrokeStyles**(`ctx`, `style`): `object` -Defined in: [src/shapes/Text/Text.ts:1321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1321) +Defined in: [src/shapes/Text/Text.ts:1331](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1331) This function prepare the canvas for a stroke style, and stroke and strokeWidth need to be sent in as defined @@ -3065,7 +3082,7 @@ with stroke and strokeWidth defined > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -3092,7 +3109,7 @@ Rendering canvas context > **\_splitTextIntoLines**(`text`): `TextLinesInfo` -Defined in: [src/shapes/Text/Text.ts:1745](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1745) +Defined in: [src/shapes/Text/Text.ts:1762](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1762) Returns the text as an array of lines. @@ -3120,7 +3137,7 @@ Lines in the text > **\_toSVG**(`_reviver?`): `string`[] -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:126](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L126) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L136) Returns svg representation of an instance This function is implemented in each subclass @@ -3149,7 +3166,7 @@ of the instance > **abortCursorAnimation**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:183](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L183) +Defined in: [src/shapes/IText/ITextBehavior.ts:183](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L183) Aborts cursor animation, clears all timeouts and clear textarea context if necessary @@ -3167,7 +3184,7 @@ Aborts cursor animation, clears all timeouts and clear textarea context if neces > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -3189,7 +3206,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -3236,7 +3253,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **blur**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L106) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L106) Override this method to customize cursor behavior on textbox blur @@ -3254,7 +3271,7 @@ Override this method to customize cursor behavior on textbox blur > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -3273,7 +3290,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -3294,7 +3311,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -3315,7 +3332,7 @@ transform matrix for the object > **calcTextHeight**(): `number` -Defined in: [src/shapes/Text/Text.ts:1051](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1051) +Defined in: [src/shapes/Text/Text.ts:1061](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1061) Calculate text box height @@ -3333,7 +3350,7 @@ Calculate text box height > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -3363,7 +3380,7 @@ transform matrix for the object > **canDrop**(`e`): `boolean` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L64) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L64) override this method to control whether instance should/shouldn't become a drop target @@ -3387,7 +3404,7 @@ override this method to control whether instance should/shouldn't become a drop > **cleanStyle**(`property`): `undefined` \| `false` -Defined in: [src/shapes/Text/StyledText.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L98) +Defined in: [src/shapes/Text/StyledText.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L98) Check if characters in a text have a value for a property whose value matches the textbox's value for that property. If so, @@ -3416,7 +3433,7 @@ then it also is deleted. > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -3452,7 +3469,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`IText`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -3478,7 +3495,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -3515,7 +3532,7 @@ fix the export type, it could not be Image but the type that getClass return for > **cmdAll**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L230) +Defined in: [src/shapes/IText/ITextBehavior.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L230) Selects entire text and updates the visual state @@ -3533,7 +3550,7 @@ Selects entire text and updates the visual state > **complexity**(): `number` -Defined in: [src/shapes/Text/Text.ts:1810](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1810) +Defined in: [src/shapes/Text/Text.ts:1827](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1827) Returns complexity of an instance @@ -3553,7 +3570,7 @@ complexity > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -3581,7 +3598,7 @@ true if point is inside the object > **copy**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:301](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L301) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:301](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L301) Copies selected text @@ -3599,7 +3616,7 @@ Copies selected text > **dispose**(): `void` -Defined in: [src/shapes/IText/IText.ts:771](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L771) +Defined in: [src/shapes/IText/IText.ts:770](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L770) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -3618,7 +3635,7 @@ override if necessary to dispose artifacts such as `clipPath` > **doubleClickHandler**(`options`): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L71) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L71) Default handler for double click, select a word @@ -3642,7 +3659,7 @@ Default handler for double click, select a word > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -3682,7 +3699,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -3712,7 +3729,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -3746,7 +3763,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -3783,7 +3800,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -3817,7 +3834,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -3855,7 +3872,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -3890,7 +3907,7 @@ it seemed a good option, now is an edge case > **enlargeSpaces**(): `void` -Defined in: [src/shapes/Text/Text.ts:496](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L496) +Defined in: [src/shapes/Text/Text.ts:506](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L506) Enlarge space boxes and shift the others @@ -3908,7 +3925,7 @@ Enlarge space boxes and shift the others > **enterEditing**(`e?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:392](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L392) +Defined in: [src/shapes/IText/ITextBehavior.ts:392](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L392) Enters editing state @@ -3932,7 +3949,7 @@ Enters editing state > **enterEditingImpl**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:411](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L411) +Defined in: [src/shapes/IText/ITextBehavior.ts:411](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L411) runs the actual logic that enter from editing state, see [enterEditing](/api/classes/itext/#enterediting) @@ -3950,7 +3967,7 @@ runs the actual logic that enter from editing state, see [enterEditing](/api/cla > **exitEditing**(): `IText`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/IText/ITextBehavior.ts:726](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L726) +Defined in: [src/shapes/IText/ITextBehavior.ts:726](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L726) Exits from editing state and fires relevant events @@ -3968,7 +3985,7 @@ Exits from editing state and fires relevant events > **exitEditingImpl**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:702](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L702) +Defined in: [src/shapes/IText/ITextBehavior.ts:702](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L702) runs the actual logic that exits from editing state, see [exitEditing](/api/classes/itext/#exitediting) But it does not fire events @@ -3987,7 +4004,7 @@ But it does not fire events > **findAncestorsWithClipPath**(): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/shapes/IText/IText.ts:440](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L440) +Defined in: [src/shapes/IText/IText.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L440) Finds and returns an array of clip paths that are applied to the parent group(s) of the current FabricObject instance. The object's hierarchy is @@ -4005,7 +4022,7 @@ absolutely positioned. > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -4037,7 +4054,7 @@ an object that represent the ancestry situation. > **findLineBoundaryLeft**(`startFrom`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:296](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L296) +Defined in: [src/shapes/IText/ITextBehavior.ts:296](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L296) Find new selection index representing start of current line according to current selection index @@ -4065,7 +4082,7 @@ New selection index > **findLineBoundaryRight**(`startFrom`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L313) +Defined in: [src/shapes/IText/ITextBehavior.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L313) Find new selection index representing end of current line according to current selection index @@ -4093,7 +4110,7 @@ New selection index > **findWordBoundaryLeft**(`startFrom`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:248](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L248) +Defined in: [src/shapes/IText/ITextBehavior.ts:248](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L248) Find new selection index representing start of current word according to current selection index @@ -4121,7 +4138,7 @@ New selection index > **findWordBoundaryRight**(`startFrom`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:272](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L272) +Defined in: [src/shapes/IText/ITextBehavior.ts:272](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L272) Find new selection index representing end of current word according to current selection index @@ -4149,7 +4166,7 @@ New selection index > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -4187,7 +4204,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -4214,7 +4231,7 @@ function to iterate over the controls over > **fromGraphemeToStringSelection**(`start`, `end`, `graphemes`): `object` -Defined in: [src/shapes/IText/ITextBehavior.ts:504](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L504) +Defined in: [src/shapes/IText/ITextBehavior.ts:504](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L504) convert from fabric to textarea values @@ -4254,7 +4271,7 @@ convert from fabric to textarea values > **fromStringToGraphemeSelection**(`start`, `end`, `text`): `object` -Defined in: [src/shapes/IText/ITextBehavior.ts:487](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L487) +Defined in: [src/shapes/IText/ITextBehavior.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L487) convert from textarea to grapheme indexes @@ -4294,7 +4311,7 @@ convert from textarea to grapheme indexes > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -4322,7 +4339,7 @@ value of a property > **get2DCursorLocation**(`selectionStart?`, `skipWrapping?`): `object` -Defined in: [src/shapes/IText/IText.ts:339](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L339) +Defined in: [src/shapes/IText/IText.ts:339](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L339) Returns 2d representation (lineIndex and charIndex) of cursor (or selection start) @@ -4362,7 +4379,7 @@ consider the location for unwrapped lines. useful to manage styles. > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -4378,7 +4395,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -4396,7 +4413,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -4417,7 +4434,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -4433,7 +4450,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -4451,7 +4468,7 @@ Returns the center coordinates of the object relative to canvas > **getCompleteStyleDeclaration**(`lineIndex`, `charIndex`): [`CompleteTextStyleDeclaration`](/api/type-aliases/completetextstyledeclaration/) -Defined in: [src/shapes/Text/StyledText.ts:273](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L273) +Defined in: [src/shapes/Text/StyledText.ts:273](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L273) return a new object that contains all the style property for a character the object returned is newly created @@ -4486,7 +4503,7 @@ style object > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -4504,7 +4521,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getCurrentCharColor**(): `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/IText/IText.ts:755](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L755) +Defined in: [src/shapes/IText/IText.ts:754](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L754) High level function to know the color of the cursor. the currentChar is the one that precedes the cursor @@ -4524,7 +4541,7 @@ Character color (fill) > **getCurrentCharFontSize**(): `number` -Defined in: [src/shapes/IText/IText.ts:742](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L742) +Defined in: [src/shapes/IText/IText.ts:741](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L741) High level function to know the height of the cursor. the currentChar is the one that precedes the cursor @@ -4543,7 +4560,7 @@ Character font size > **getCursorRenderingData**(`selectionStart`, `boundaries`): [`CursorRenderingData`](/api/type-aliases/cursorrenderingdata/) -Defined in: [src/shapes/IText/IText.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L567) +Defined in: [src/shapes/IText/IText.ts:567](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L567) Return the data needed to render the cursor for given selection start The left,top are relative to the object, while width and height are prescaled @@ -4570,7 +4587,7 @@ so they depend on canvas and object scaling > **getDownCursorOffset**(`e`, `isRight`): `number` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:351](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L351) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:351](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L351) Gets start offset of a selection @@ -4600,7 +4617,7 @@ Event object > **getHeightOfChar**(`line`, `_char`): `number` -Defined in: [src/shapes/Text/Text.ts:862](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L862) +Defined in: [src/shapes/Text/Text.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L872) Computes height of character at given position @@ -4634,7 +4651,7 @@ fontSize of the character > **getHeightOfLine**(`lineIndex`): `number` -Defined in: [src/shapes/Text/Text.ts:1044](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1044) +Defined in: [src/shapes/Text/Text.ts:1054](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1054) Calculate height of line at 'lineIndex' @@ -4660,7 +4677,7 @@ index of line to calculate > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -4678,7 +4695,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -4696,7 +4713,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/itext/#getpositionbyorigin) @@ -4728,7 +4745,7 @@ use [getPositionByOrigin](/api/classes/itext/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/itext/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -4766,7 +4783,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -4784,7 +4801,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -4803,7 +4820,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/itext > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -4821,7 +4838,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -4840,7 +4857,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/itext > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -4864,7 +4881,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -4888,7 +4905,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSelectedText**(): `string` -Defined in: [src/shapes/IText/ITextBehavior.ts:239](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L239) +Defined in: [src/shapes/IText/ITextBehavior.ts:239](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L239) Returns selected text @@ -4906,7 +4923,7 @@ Returns selected text > **getSelectionStartFromPointer**(`e`): `number` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L193) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L193) Returns index of a character corresponding to where an object was clicked @@ -4934,7 +4951,7 @@ Index of a character > **getSelectionStyles**(`startIndex`, `endIndex`, `complete?`): `Partial`\<[`CompleteTextStyleDeclaration`](/api/type-aliases/completetextstyledeclaration/)\>[] -Defined in: [src/shapes/IText/IText.ts:312](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L312) +Defined in: [src/shapes/IText/IText.ts:312](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L312) Gets style of a current selection/cursor (at the start position) if startIndex or endIndex are not provided, selectionStart or selectionEnd will be used. @@ -4975,7 +4992,7 @@ styles an array with one, zero or more Style objects > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -4999,7 +5016,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -5023,7 +5040,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -5053,7 +5070,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -5085,7 +5102,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -5103,7 +5120,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -5123,7 +5140,7 @@ object with scaleX and scaleY properties > **getUpCursorOffset**(`e`, `isRight`): `number` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L396) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L396) #### Parameters @@ -5151,7 +5168,7 @@ Event object > **getValueOfPropertyAt**\<`T`\>(`lineIndex`, `charIndex`, `property`): `IText`\<`Props`, `SProps`, `EventSpec`\>\[`T`\] -Defined in: [src/shapes/Text/Text.ts:1540](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1540) +Defined in: [src/shapes/Text/Text.ts:1550](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1550) Retrieves the value of property at given character position @@ -5197,7 +5214,7 @@ the value of 'property' > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -5215,7 +5232,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -5233,7 +5250,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -5251,7 +5268,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -5269,7 +5286,7 @@ y position according to object's originY property in canvas coordinate plane > **graphemeSplit**(`value`): `string`[] -Defined in: [src/shapes/Text/Text.ts:1736](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1736) +Defined in: [src/shapes/Text/Text.ts:1753](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1753) Override this method to customize grapheme splitting @@ -5301,7 +5318,7 @@ in the middle of the prototype chain > **handleFiller**\<`T`\>(`ctx`, `property`, `filler`): `object` -Defined in: [src/shapes/Text/Text.ts:1281](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1281) +Defined in: [src/shapes/Text/Text.ts:1291](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1291) #### Type Parameters @@ -5345,7 +5362,7 @@ Defined in: [src/shapes/Text/Text.ts:1281](https://github.com/fabricjs/fabric.js > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -5373,7 +5390,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -5402,7 +5419,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -5431,7 +5448,7 @@ Boolean > **initBehavior**(): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L26) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L26) Initializes all the interactive behavior of IText @@ -5449,7 +5466,7 @@ Initializes all the interactive behavior of IText > **initDelayedCursor**(`restart?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:175](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L175) +Defined in: [src/shapes/IText/ITextBehavior.ts:175](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L175) Initializes delayed cursor @@ -5473,7 +5490,7 @@ Initializes delayed cursor > **initHiddenTextarea**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L62) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L62) Initializes hidden textarea (needed to bring up keyboard in iOS) @@ -5491,7 +5508,7 @@ Initializes hidden textarea (needed to bring up keyboard in iOS) > **insertChars**(`text`, `style`, `start`, `end`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:1062](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L1062) +Defined in: [src/shapes/IText/ITextBehavior.ts:1062](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L1062) insert characters at start position, before start position. start equal 1 it means the text get inserted between actual grapheme 0 and 1 @@ -5537,7 +5554,7 @@ default to start + 1 > **insertCharStyleObject**(`lineIndex`, `charIndex`, `quantity`, `copiedStyle?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:912](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L912) +Defined in: [src/shapes/IText/ITextBehavior.ts:912](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L912) Inserts style object for a given line/char index @@ -5581,7 +5598,7 @@ array of style objects > **insertNewlineStyleObject**(`lineIndex`, `charIndex`, `qty`, `copiedStyle?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:843](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L843) +Defined in: [src/shapes/IText/ITextBehavior.ts:843](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L843) Handle insertion of more consecutive style lines for when one or more newlines gets added to the text. Since current style needs to be shifted @@ -5626,7 +5643,7 @@ Array of objects styles > **insertNewStyleBlock**(`insertedText`, `start`, `copiedStyle?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:970](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L970) +Defined in: [src/shapes/IText/ITextBehavior.ts:970](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L970) Inserts style object(s) @@ -5664,7 +5681,7 @@ array of style objects to insert. > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -5692,7 +5709,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -5720,7 +5737,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -5750,7 +5767,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -5778,7 +5795,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -5806,7 +5823,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -5835,7 +5852,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -5860,7 +5877,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isEmptyStyles**(`lineIndex?`): `boolean` -Defined in: [src/shapes/Text/StyledText.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L41) +Defined in: [src/shapes/Text/StyledText.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L41) Returns true if object has no styling or no styling in a line @@ -5886,7 +5903,7 @@ Returns true if object has no styling or no styling in a line > **isEndOfWrapping**(`lineIndex`): `boolean` -Defined in: [src/shapes/Text/Text.ts:540](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L540) +Defined in: [src/shapes/Text/Text.ts:550](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L550) Detect if the text line is ended with an hard break text and itext do not have wrapping, return false @@ -5911,7 +5928,7 @@ text and itext do not have wrapping, return false > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -5943,7 +5960,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -5961,7 +5978,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -5982,7 +5999,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -6010,7 +6027,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -6030,7 +6047,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -6066,7 +6083,7 @@ A list of type strings to check against. > **measureLine**(`lineIndex`): `object` -Defined in: [src/shapes/Text/Text.ts:870](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L870) +Defined in: [src/shapes/Text/Text.ts:880](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L880) measure a text line measuring all characters. @@ -6100,7 +6117,7 @@ line number > **missingNewlineOffset**(`lineIndex`, `skipWrapping?`): `0` \| `1` -Defined in: [src/shapes/Text/Text.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L550) +Defined in: [src/shapes/Text/Text.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L560) Detect if a line has a linebreak and so we need to account for it when moving and counting style. @@ -6132,7 +6149,7 @@ Number > **moveCursorDown**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:457](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L457) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:457](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L457) Moves cursor down @@ -6158,7 +6175,7 @@ Event object > **moveCursorLeft**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:542](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L542) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:542](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L542) Moves cursor left @@ -6184,7 +6201,7 @@ Event object > **moveCursorLeftWithoutShift**(`e`): `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:594](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L594) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L594) Moves cursor left without keeping selection @@ -6208,7 +6225,7 @@ Moves cursor left without keeping selection > **moveCursorLeftWithShift**(`e`): `undefined` \| `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:614](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L614) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:614](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L614) Moves cursor left while keeping selection @@ -6232,7 +6249,7 @@ Moves cursor left while keeping selection > **moveCursorRight**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:630](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L630) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:630](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L630) Moves cursor right @@ -6258,7 +6275,7 @@ Event object > **moveCursorRightWithoutShift**(`e`): `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:680](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L680) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:680](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L680) Moves cursor right without keeping selection @@ -6284,7 +6301,7 @@ Event object > **moveCursorRightWithShift**(`e`): `undefined` \| `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:664](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L664) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:664](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L664) Moves cursor right while keeping selection @@ -6308,7 +6325,7 @@ Moves cursor right while keeping selection > **moveCursorUp**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:471](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L471) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:471](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L471) Moves cursor up @@ -6334,7 +6351,7 @@ Event object > **moveCursorWithoutShift**(`offset`): `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:527](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L527) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L527) Moves cursor up without shift @@ -6358,7 +6375,7 @@ Moves cursor up without shift > **moveCursorWithShift**(`offset`): `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:510](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L510) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:510](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L510) Moves cursor with shift @@ -6382,7 +6399,7 @@ Moves cursor with shift > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -6408,7 +6425,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -6444,7 +6461,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -6480,7 +6497,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -6504,7 +6521,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -6524,7 +6541,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -6570,7 +6587,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -6604,7 +6621,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -6650,7 +6667,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -6682,7 +6699,7 @@ once > **onCompositionEnd**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:287](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L287) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:287](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L287) Composition end @@ -6700,7 +6717,7 @@ Composition end > **onCompositionStart**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:280](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L280) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:280](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L280) Composition start @@ -6718,7 +6735,7 @@ Composition start > **onCompositionUpdate**(`__namedParameters`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L291) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:291](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L291) #### Parameters @@ -6740,7 +6757,7 @@ Defined in: [src/shapes/IText/ITextKeyBehavior.ts:291](https://github.com/fabric > **onDeselect**(`options?`): `boolean` -Defined in: [src/shapes/IText/ITextBehavior.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L111) +Defined in: [src/shapes/IText/ITextBehavior.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L111) 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 @@ -6776,7 +6793,7 @@ this is being deselected > **onDragStart**(`e`): `boolean` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L57) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L57) override this method to control whether instance should/shouldn't become a drag source, @@ -6807,7 +6824,7 @@ To prevent drag and drop between objects both shouldStartDragging and onDragStar > **onInput**(`this`, `e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:174](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L174) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:174](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L174) Handles onInput event @@ -6837,7 +6854,7 @@ Event object > **onKeyDown**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L115) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L115) Handles keydown event only used for arrows and combination of modifier keys. @@ -6864,7 +6881,7 @@ Event object > **onKeyUp**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L151) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L151) Handles keyup event We handle KeyUp because ie11 and edge have difficulties copy/pasting @@ -6892,7 +6909,7 @@ Event object > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -6923,7 +6940,7 @@ event if the process is generated by an event > **paste**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:323](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L323) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L323) Pastes text @@ -6941,7 +6958,7 @@ Pastes text > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -6967,7 +6984,7 @@ Places the left/top corner of the object bounding box in p. > **removeChars**(`start`, `end`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:1040](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L1040) +Defined in: [src/shapes/IText/ITextBehavior.ts:1040](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L1040) Removes characters from start/end start/end ar per grapheme position in _text array. @@ -6998,7 +7015,7 @@ default to start + 1 > **removeStyle**(`property`): `void` -Defined in: [src/shapes/Text/StyledText.ts:159](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L159) +Defined in: [src/shapes/Text/StyledText.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L159) Remove a style property or properties from all individual character styles in a text object. Deletes the character style object if it contains no other style @@ -7024,7 +7041,7 @@ props. Deletes a line style object if it contains no other character styles. > **removeStyleFromTo**(`start`, `end`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:758](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L758) +Defined in: [src/shapes/IText/ITextBehavior.ts:758](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L758) remove and reflow a style block from start to end. @@ -7056,7 +7073,7 @@ linear end position for removal ( excluded from removal ) > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -7082,7 +7099,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderCursor**(`ctx`, `boundaries`): `void` -Defined in: [src/shapes/IText/IText.ts:557](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L557) +Defined in: [src/shapes/IText/IText.ts:557](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L557) Renders cursor @@ -7108,7 +7125,7 @@ transformed context to draw on > **renderCursorAt**(`selectionStart`): `void` -Defined in: [src/shapes/IText/IText.ts:544](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L544) +Defined in: [src/shapes/IText/IText.ts:544](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L544) Renders cursor on context Top, outside the animation cycle, on request Used for the drag/drop effect. @@ -7130,7 +7147,7 @@ If contextTop is not available, do nothing. > **renderCursorOrSelection**(): `void` -Defined in: [src/shapes/IText/IText.ts:374](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L374) +Defined in: [src/shapes/IText/IText.ts:374](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L374) Renders cursor or selection (depending on what exists) it does on the contextTop. If contextTop is not available, do nothing. @@ -7149,7 +7166,7 @@ it does on the contextTop. If contextTop is not available, do nothing. > **renderDragSourceEffect**(): `void` -Defined in: [src/shapes/IText/IText.ts:633](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L633) +Defined in: [src/shapes/IText/IText.ts:633](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L633) Renders drag start text selection @@ -7167,7 +7184,7 @@ Renders drag start text selection > **renderDropTargetEffect**(`e`): `void` -Defined in: [src/shapes/IText/IText.ts:643](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L643) +Defined in: [src/shapes/IText/IText.ts:643](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L643) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -7194,7 +7211,7 @@ object will change when dropping. example: show the cursor where the text is abo > **renderSelection**(`ctx`, `boundaries`): `void` -Defined in: [src/shapes/IText/IText.ts:618](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L618) +Defined in: [src/shapes/IText/IText.ts:618](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L618) Renders text selection @@ -7222,7 +7239,7 @@ Object with left/top/leftOffset/topOffset > **restartCursorIfNeeded**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L206) +Defined in: [src/shapes/IText/ITextBehavior.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L206) Restart tue cursor animation if either is in complete state ( between animations ) or if it never started before @@ -7241,7 +7258,7 @@ or if it never started before > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -7267,7 +7284,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -7293,7 +7310,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -7319,7 +7336,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -7345,7 +7362,7 @@ New width value > **searchWordBoundary**(`selectionStart`, `direction`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:331](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L331) +Defined in: [src/shapes/IText/ITextBehavior.ts:331](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L331) Finds index corresponding to beginning or end of a word @@ -7379,7 +7396,7 @@ Index of the beginning or end of a word > **selectAll**(): `IText`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/IText/ITextBehavior.ts:219](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L219) +Defined in: [src/shapes/IText/ITextBehavior.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L219) Selects entire text @@ -7397,7 +7414,7 @@ Selects entire text > **selectLine**(`selectionStart?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:378](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L378) +Defined in: [src/shapes/IText/ITextBehavior.ts:378](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L378) Selects the line that contains selectionStart @@ -7423,7 +7440,7 @@ Index of a character > **selectWord**(`selectionStart?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:356](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L356) +Defined in: [src/shapes/IText/ITextBehavior.ts:356](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L356) Selects the word that contains the char at index selectionStart @@ -7449,7 +7466,7 @@ Index of a character > **set**(`key`, `value?`): `IText`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Text/Text.ts:1779](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1779) +Defined in: [src/shapes/Text/Text.ts:1796](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1796) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -7481,7 +7498,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -7508,7 +7525,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -7546,7 +7563,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -7565,7 +7582,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setCursorByClick**(`e`): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:172](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L172) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:172](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L172) Changes cursor location in a text depending on passed pointer (x/y) object @@ -7591,7 +7608,7 @@ Event object > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -7612,7 +7629,7 @@ Travis build error about unused variables. > **setPathInfo**(): `void` -Defined in: [src/shapes/Text/Text.ts:450](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L450) +Defined in: [src/shapes/Text/Text.ts:460](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L460) If text has a path, it will add the extra information needed for path and text calculations @@ -7631,7 +7648,7 @@ for path and text calculations > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -7669,7 +7686,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -7694,7 +7711,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/itext/# > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/itext/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -7732,7 +7749,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -7757,7 +7774,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/itext > **setSelectionEnd**(`index`): `void` -Defined in: [src/shapes/IText/IText.ts:262](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L262) +Defined in: [src/shapes/IText/IText.ts:262](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L262) Sets selection end (right boundary of a selection) @@ -7779,7 +7796,7 @@ Index to set selection end to > **setSelectionStart**(`index`): `void` -Defined in: [src/shapes/IText/IText.ts:253](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L253) +Defined in: [src/shapes/IText/IText.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L253) Sets selection start (left boundary of a selection) @@ -7801,7 +7818,7 @@ Index to set selection start to > **setSelectionStartEndWithShift**(`start`, `end`, `newSelection`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:1089](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L1089) +Defined in: [src/shapes/IText/ITextBehavior.ts:1089](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L1089) Set the selectionStart and selectionEnd according to the new position of cursor mimic the key - mouse navigation when shift is pressed. @@ -7834,7 +7851,7 @@ mimic the key - mouse navigation when shift is pressed. > **setSelectionStyles**(`styles?`, `startIndex?`, `endIndex?`): `void` -Defined in: [src/shapes/IText/IText.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L326) +Defined in: [src/shapes/IText/IText.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L326) Sets style of a current selection, if no selection exist, do not set anything. @@ -7872,7 +7889,7 @@ End index to get styles at, if not specified selectionEnd or startIndex + 1 > **setSubscript**(`start`, `end`): `void` -Defined in: [src/shapes/Text/Text.ts:1422](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1422) +Defined in: [src/shapes/Text/Text.ts:1432](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1432) Turns the character into an 'inferior figure' (i.e. 'subscript') @@ -7904,7 +7921,7 @@ selection end > **setSuperscript**(`start`, `end`): `void` -Defined in: [src/shapes/Text/Text.ts:1413](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1413) +Defined in: [src/shapes/Text/Text.ts:1423](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1423) Turns the character into a 'superior figure' (i.e. 'superscript') @@ -7936,7 +7953,7 @@ selection end > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -7960,7 +7977,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -8006,7 +8023,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -8030,7 +8047,7 @@ y position according to object's originY property in canvas coordinate plane > **shiftLineStyles**(`lineIndex`, `offset`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:820](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L820) +Defined in: [src/shapes/IText/ITextBehavior.ts:820](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L820) Shifts line styles up or down @@ -8062,7 +8079,7 @@ Can any number? > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -8085,7 +8102,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(): `boolean` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L47) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L47) If this method returns true a mouse move operation over a text selection will not prevent the native mouse event allowing the browser to start a drag operation. @@ -8106,7 +8123,7 @@ To prevent drag and drop between objects both shouldStartDragging and onDragStar > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -8138,7 +8155,7 @@ the control box size used > **styleHas**(`property`, `lineIndex?`): `boolean` -Defined in: [src/shapes/Text/StyledText.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L69) +Defined in: [src/shapes/Text/StyledText.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L69) Returns true if object has a style property or has it ina specified line This function is used to detect if a text will use a particular property or not. @@ -8171,7 +8188,7 @@ to check the style on > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -8193,7 +8210,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options?`): `HTMLCanvasElement` -Defined in: [src/shapes/IText/IText.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L362) +Defined in: [src/shapes/IText/IText.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L362) block cursor/selection logic while rendering the exported canvas @@ -8221,7 +8238,7 @@ this workaround should be replaced with a more robust solution > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -8253,7 +8270,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -8281,7 +8298,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -8309,7 +8326,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `IText`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -8335,7 +8352,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -8355,7 +8372,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Text/Text.ts:1768](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1768) +Defined in: [src/shapes/Text/Text.ts:1785](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1785) Returns object representation of an instance @@ -8393,7 +8410,7 @@ Object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Text/Text.ts:586](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L586) +Defined in: [src/shapes/Text/Text.ts:596](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L596) Returns string representation of an instance @@ -8413,7 +8430,7 @@ String representation of text object > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -8445,7 +8462,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -8471,7 +8488,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -8493,7 +8510,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -8531,7 +8548,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -8581,7 +8598,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -8619,7 +8636,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **tripleClickHandler**(`options`): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L82) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L82) Default handler for triple click, select a line @@ -8643,7 +8660,7 @@ Default handler for triple click, select a line > **updateSelectionOnMouseMove**(`e`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:433](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L433) +Defined in: [src/shapes/IText/ITextBehavior.ts:433](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L433) called by [Canvas#textEditingManager](/api/classes/canvas/#texteditingmanager) @@ -8667,7 +8684,7 @@ called by [Canvas#textEditingManager](/api/classes/canvas/#texteditingmanager) > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -8690,7 +8707,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -8722,7 +8739,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -8746,7 +8763,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<[`FabricText`](/api/classes/fabrictext/)\<\{ `fontSize`: `number`; `left`: `number`; `linethrough`: `boolean`; `overline`: `boolean`; `signal?`: `AbortSignal`; `strokeWidth`: `number`; `top`: `number`; `underline`: `boolean`; \}, [`SerializedTextProps`](/api/interfaces/serializedtextprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Text/Text.ts:1859](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1859) +Defined in: [src/shapes/Text/Text.ts:1878](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1878) Returns FabricText instance from an SVG element (not yet implemented) @@ -8782,7 +8799,7 @@ Options object > `static` **fromObject**\<`T`, `S`\>(`object`): `Promise`\<`S`\> -Defined in: [src/shapes/Text/Text.ts:1934](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1934) +Defined in: [src/shapes/Text/Text.ts:1953](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1953) Returns FabricText instance from an object representation @@ -8818,7 +8835,7 @@ plain js Object to create an instance from > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/IText/IText.ts:207](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L207) +Defined in: [src/shapes/IText/IText.ts:207](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L207) #### Returns diff --git a/src/content/docs/api/classes/InteractiveFabricObject.md b/src/content/docs/api/classes/InteractiveFabricObject.md index b5662070..3372edeb 100644 --- a/src/content/docs/api/classes/InteractiveFabricObject.md +++ b/src/content/docs/api/classes/InteractiveFabricObject.md @@ -5,7 +5,7 @@ prev: false title: "InteractiveFabricObject" --- -Defined in: [src/shapes/Object/InteractiveObject.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L43) +Defined in: [src/shapes/Object/InteractiveObject.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L46) Exported so we can tweak default values @@ -41,7 +41,7 @@ Exported so we can tweak default values > **new InteractiveFabricObject**\<`Props`, `SProps`, `EventSpec`\>(`options?`): `InteractiveFabricObject`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L151) +Defined in: [src/shapes/Object/InteractiveObject.ts:154](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L154) Constructor @@ -67,7 +67,7 @@ Options object > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -81,7 +81,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -93,7 +93,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -111,7 +111,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -140,7 +140,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -159,7 +159,7 @@ You can calculate them without updating with [()](/api/classes/interactivefabric > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -183,7 +183,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -202,7 +202,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -222,7 +222,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -240,7 +240,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -260,7 +260,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -284,7 +284,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -310,7 +310,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -333,7 +333,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -354,7 +354,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -365,7 +365,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -385,7 +385,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -409,7 +409,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -429,7 +429,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -453,7 +453,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -483,7 +483,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -504,7 +504,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -518,7 +518,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -540,7 +540,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -565,7 +565,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -591,7 +591,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -615,7 +615,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -639,7 +639,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -657,7 +657,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -671,7 +671,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -691,7 +691,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -709,7 +709,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -729,7 +729,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -747,7 +747,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -773,7 +773,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -784,7 +784,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -810,7 +810,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -824,7 +824,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -838,7 +838,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -852,7 +852,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -866,7 +866,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -880,7 +880,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -894,7 +894,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -908,7 +908,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -922,7 +922,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -936,7 +936,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -960,7 +960,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -980,11 +980,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1004,7 +1004,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1034,7 +1034,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1047,7 +1047,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1071,7 +1071,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1091,7 +1091,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1111,7 +1111,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1125,7 +1125,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1149,7 +1149,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1167,7 +1167,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1182,7 +1182,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1196,7 +1196,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1220,7 +1220,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1244,7 +1244,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1259,7 +1259,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1278,7 +1278,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1302,7 +1302,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1326,7 +1326,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1350,7 +1350,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1364,7 +1364,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1379,7 +1379,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1404,7 +1404,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1428,7 +1428,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1452,7 +1452,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1476,7 +1476,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1494,7 +1494,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1518,7 +1518,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1555,7 +1555,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1579,7 +1579,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1605,7 +1605,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1625,7 +1625,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1645,7 +1645,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1663,7 +1663,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1681,7 +1681,7 @@ Object width > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L234) +Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L234) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1698,7 +1698,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1712,7 +1712,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1727,7 +1727,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`InteractiveFabricObject`\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `interactiveObjectDefaultValues` -Defined in: [src/shapes/Object/InteractiveObject.ts:138](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L138) +Defined in: [src/shapes/Object/InteractiveObject.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L141) #### Overrides @@ -1739,7 +1739,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:138](https://github.com/fabr > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1755,7 +1755,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'FabricObject'` -Defined in: [src/shapes/Object/Object.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L343) +Defined in: [src/shapes/Object/Object.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L343) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1778,7 +1778,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1801,7 +1801,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1823,7 +1823,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -1855,7 +1855,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -1885,7 +1885,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -1903,7 +1903,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -1936,7 +1936,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -1958,7 +1958,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -1984,7 +1984,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -2010,7 +2010,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2037,7 +2037,7 @@ Rendering canvas context > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2084,7 +2084,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2103,7 +2103,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2120,7 +2120,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2141,7 +2141,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2171,7 +2171,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2193,7 +2193,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2225,7 +2225,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`InteractiveFabricObject`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2251,7 +2251,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2288,7 +2288,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1429) +Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1429) Returns complexity of an instance @@ -2308,7 +2308,7 @@ complexity of this instance (is 1 unless subclassed) > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2336,7 +2336,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2355,7 +2355,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2391,7 +2391,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2421,7 +2421,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2455,7 +2455,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2488,7 +2488,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2518,7 +2518,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2556,7 +2556,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2591,7 +2591,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2623,7 +2623,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2661,7 +2661,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2684,7 +2684,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2712,7 +2712,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -2724,7 +2724,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -2742,7 +2742,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -2763,7 +2763,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -2779,7 +2779,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -2797,7 +2797,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -2815,7 +2815,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -2833,7 +2833,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -2851,7 +2851,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/interactivefabricobject/#getpositionbyorigin) @@ -2883,7 +2883,7 @@ use [getPositionByOrigin](/api/classes/interactivefabricobject/#getpositionbyori > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/interactivefabricobject/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -2921,7 +2921,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -2939,7 +2939,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -2958,7 +2958,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/inter > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -2976,7 +2976,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -2995,7 +2995,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/inter > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3019,7 +3019,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3043,7 +3043,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3061,7 +3061,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3081,7 +3081,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3099,7 +3099,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3117,7 +3117,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3135,7 +3135,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3153,7 +3153,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3181,7 +3181,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3210,7 +3210,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3239,7 +3239,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3267,7 +3267,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3295,7 +3295,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3325,7 +3325,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3353,7 +3353,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3381,7 +3381,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3406,7 +3406,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3431,7 +3431,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3463,7 +3463,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3481,7 +3481,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3502,7 +3502,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3530,7 +3530,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3550,7 +3550,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -3586,7 +3586,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -3612,7 +3612,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -3648,7 +3648,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -3684,7 +3684,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -3708,7 +3708,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -3728,7 +3728,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -3774,7 +3774,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -3808,7 +3808,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -3854,7 +3854,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -3886,7 +3886,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -3915,7 +3915,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -3938,7 +3938,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -3965,7 +3965,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -3991,7 +3991,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4017,7 +4017,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4043,7 +4043,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4065,7 +4065,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4088,7 +4088,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4114,7 +4114,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4140,7 +4140,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4166,7 +4166,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4192,7 +4192,7 @@ New width value > **set**(`key`, `value?`): `InteractiveFabricObject`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4224,7 +4224,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4247,7 +4247,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4281,7 +4281,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4300,7 +4300,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4321,7 +4321,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4359,7 +4359,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4384,7 +4384,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/interac > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/interactivefabricobject/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4422,7 +4422,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4447,7 +4447,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/inter > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4471,7 +4471,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4517,7 +4517,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4541,7 +4541,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -4564,7 +4564,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -4587,7 +4587,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -4615,7 +4615,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -4637,7 +4637,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -4665,7 +4665,7 @@ Returns DOM element with the FabricObject > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -4693,7 +4693,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -4721,7 +4721,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `InteractiveFabricObject`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -4747,7 +4747,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -4767,7 +4767,7 @@ JSON > **toObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1756) +Defined in: [src/shapes/Object/Object.ts:1756](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1756) Returns an object representation of an instance @@ -4795,7 +4795,7 @@ Object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -4813,7 +4813,7 @@ Returns a string representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -4839,7 +4839,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -4861,7 +4861,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -4899,7 +4899,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -4949,7 +4949,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -4987,7 +4987,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5010,7 +5010,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5042,7 +5042,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5062,7 +5062,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromObject**\<`T`\>(`object`, `options?`): `Promise`\<[`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1931) +Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1931) #### Type Parameters @@ -5094,7 +5094,7 @@ Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabri > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L140) +Defined in: [src/shapes/Object/InteractiveObject.ts:143](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L143) #### Returns diff --git a/src/content/docs/api/classes/Intersection.md b/src/content/docs/api/classes/Intersection.md index 06c9f46f..9b0b6a3a 100644 --- a/src/content/docs/api/classes/Intersection.md +++ b/src/content/docs/api/classes/Intersection.md @@ -5,7 +5,7 @@ prev: false title: "Intersection" --- -Defined in: [src/Intersection.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L8) +Defined in: [src/Intersection.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L8) ## Constructors @@ -13,7 +13,7 @@ Defined in: [src/Intersection.ts:8](https://github.com/fabricjs/fabric.js/blob/2 > **new Intersection**(`status?`): `Intersection` -Defined in: [src/Intersection.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L13) +Defined in: [src/Intersection.ts:13](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L13) #### Parameters @@ -31,7 +31,7 @@ Defined in: [src/Intersection.ts:13](https://github.com/fabricjs/fabric.js/blob/ > **points**: [`Point`](/api/classes/point/)[] -Defined in: [src/Intersection.ts:9](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L9) +Defined in: [src/Intersection.ts:9](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L9) *** @@ -39,7 +39,7 @@ Defined in: [src/Intersection.ts:9](https://github.com/fabricjs/fabric.js/blob/2 > `optional` **status**: [`IntersectionType`](/api/type-aliases/intersectiontype/) -Defined in: [src/Intersection.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L11) +Defined in: [src/Intersection.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L11) ## Methods @@ -47,7 +47,7 @@ Defined in: [src/Intersection.ts:11](https://github.com/fabricjs/fabric.js/blob/ > `static` **intersectLineLine**(`a1`, `a2`, `b1`, `b2`, `aInfinite?`, `bInfinite?`): `Intersection` -Defined in: [src/Intersection.ts:125](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L125) +Defined in: [src/Intersection.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L125) Checks if a line intersects another @@ -96,7 +96,7 @@ check segment intersection by passing `false` > `static` **intersectLinePolygon**(`a1`, `a2`, `points`, `infinite?`): `Intersection` -Defined in: [src/Intersection.ts:219](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L219) +Defined in: [src/Intersection.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L219) Checks if line intersects polygon @@ -144,7 +144,7 @@ account for stroke > `static` **intersectPolygonPolygon**(`points1`, `points2`): `Intersection` -Defined in: [src/Intersection.ts:270](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L270) +Defined in: [src/Intersection.ts:270](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L270) Checks if polygon intersects another polygon @@ -172,7 +172,7 @@ account for stroke > `static` **intersectPolygonRectangle**(`points`, `r1`, `r2`): `Intersection` -Defined in: [src/Intersection.ts:307](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L307) +Defined in: [src/Intersection.ts:307](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L307) Checks if polygon intersects rectangle @@ -210,7 +210,7 @@ bottom right point of rect > `static` **intersectSegmentLine**(`s1`, `s2`, `l1`, `l2`): `Intersection` -Defined in: [src/Intersection.ts:180](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L180) +Defined in: [src/Intersection.ts:180](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L180) Checks if a segment intersects a line @@ -254,7 +254,7 @@ other point on line > `static` **intersectSegmentPolygon**(`a1`, `a2`, `points`): `Intersection` -Defined in: [src/Intersection.ts:253](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L253) +Defined in: [src/Intersection.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L253) Checks if segment intersects polygon @@ -292,7 +292,7 @@ polygon points > `static` **intersectSegmentSegment**(`a1`, `a2`, `b1`, `b2`): `Intersection` -Defined in: [src/Intersection.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L198) +Defined in: [src/Intersection.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L198) Checks if a segment intersects another @@ -336,7 +336,7 @@ other boundary point of segment > `static` **isPointContained**(`T`, `A`, `B`, `infinite?`): `boolean` -Defined in: [src/Intersection.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L50) +Defined in: [src/Intersection.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L50) check if point T is on the segment or line defined between A and B @@ -378,7 +378,7 @@ true if `T` is contained > `static` **isPointInPolygon**(`point`, `points`): `boolean` -Defined in: [src/Intersection.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L90) +Defined in: [src/Intersection.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L90) Use the ray casting algorithm to determine if point is in the polygon defined by points diff --git a/src/content/docs/api/classes/LayoutManager.md b/src/content/docs/api/classes/LayoutManager.md index fb75d16c..edaeb0f6 100644 --- a/src/content/docs/api/classes/LayoutManager.md +++ b/src/content/docs/api/classes/LayoutManager.md @@ -5,7 +5,7 @@ prev: false title: "LayoutManager" --- -Defined in: [src/LayoutManager/LayoutManager.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L45) +Defined in: [src/LayoutManager/LayoutManager.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L45) ## Constructors @@ -13,7 +13,7 @@ Defined in: [src/LayoutManager/LayoutManager.ts:45](https://github.com/fabricjs/ > **new LayoutManager**(`strategy`): `LayoutManager` -Defined in: [src/LayoutManager/LayoutManager.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L51) +Defined in: [src/LayoutManager/LayoutManager.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L51) #### Parameters @@ -31,7 +31,7 @@ Defined in: [src/LayoutManager/LayoutManager.ts:51](https://github.com/fabricjs/ > **strategy**: [`LayoutStrategy`](/api/classes/layoutstrategy/) -Defined in: [src/LayoutManager/LayoutManager.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L49) +Defined in: [src/LayoutManager/LayoutManager.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L49) ## Methods @@ -39,7 +39,7 @@ Defined in: [src/LayoutManager/LayoutManager.ts:49](https://github.com/fabricjs/ > **dispose**(): `void` -Defined in: [src/LayoutManager/LayoutManager.ts:340](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L340) +Defined in: [src/LayoutManager/LayoutManager.ts:340](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L340) #### Returns @@ -51,7 +51,7 @@ Defined in: [src/LayoutManager/LayoutManager.ts:340](https://github.com/fabricjs > **performLayout**(`context`): `void` -Defined in: [src/LayoutManager/LayoutManager.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L56) +Defined in: [src/LayoutManager/LayoutManager.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L56) #### Parameters @@ -69,7 +69,7 @@ Defined in: [src/LayoutManager/LayoutManager.ts:56](https://github.com/fabricjs/ > **subscribeTargets**(`context`): `void` -Defined in: [src/LayoutManager/LayoutManager.ts:156](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L156) +Defined in: [src/LayoutManager/LayoutManager.ts:156](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L156) #### Parameters @@ -87,7 +87,7 @@ Defined in: [src/LayoutManager/LayoutManager.ts:156](https://github.com/fabricjs > **toJSON**(): `object` -Defined in: [src/LayoutManager/LayoutManager.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L353) +Defined in: [src/LayoutManager/LayoutManager.ts:353](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L353) #### Returns @@ -107,7 +107,7 @@ Defined in: [src/LayoutManager/LayoutManager.ts:353](https://github.com/fabricjs > **toObject**(): `object` -Defined in: [src/LayoutManager/LayoutManager.ts:346](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L346) +Defined in: [src/LayoutManager/LayoutManager.ts:346](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L346) #### Returns @@ -127,7 +127,7 @@ Defined in: [src/LayoutManager/LayoutManager.ts:346](https://github.com/fabricjs > **unsubscribeTargets**(`context`): `void` -Defined in: [src/LayoutManager/LayoutManager.ts:150](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L150) +Defined in: [src/LayoutManager/LayoutManager.ts:150](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L150) #### Parameters diff --git a/src/content/docs/api/classes/LayoutStrategy.md b/src/content/docs/api/classes/LayoutStrategy.md index b881b0de..09833c96 100644 --- a/src/content/docs/api/classes/LayoutStrategy.md +++ b/src/content/docs/api/classes/LayoutStrategy.md @@ -5,7 +5,7 @@ prev: false title: "LayoutStrategy" --- -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L21) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L21) Exposes a main public method [calcLayoutResult](/api/classes/layoutstrategy/#calclayoutresult) that is used by the `LayoutManager` to perform layout. Returning `undefined` signals the `LayoutManager` to skip the layout. @@ -34,7 +34,7 @@ In charge of calculating the bounding box of the passed objects. > `static` **type**: `string` = `'strategy'` -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L25) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L25) override by subclass for persistence (TS does not support `static abstract`) @@ -44,7 +44,7 @@ override by subclass for persistence (TS does not support `static abstract`) > **calcBoundingBox**(`objects`, `context`): `undefined` \| [`LayoutStrategyResult`](/api/type-aliases/layoutstrategyresult/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L68) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L68) Override this method to customize layout. @@ -68,7 +68,7 @@ Override this method to customize layout. > **calcLayoutResult**(`context`, `objects`): `undefined` \| [`LayoutStrategyResult`](/api/type-aliases/layoutstrategyresult/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L33) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L33) Used by the `LayoutManager` to perform layout @TODO/fix: if this method is calcResult, should calc unconditionally. @@ -96,7 +96,7 @@ layout result **OR** `undefined` to skip layout > **getInitialSize**(`context`, `result`): [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L58) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L58) #### Parameters @@ -118,7 +118,7 @@ Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:58](https://gi > **shouldLayoutClipPath**(`__namedParameters`): `undefined` \| `boolean` -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L50) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L50) #### Parameters @@ -136,7 +136,7 @@ Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:50](https://gi > **shouldPerformLayout**(`__namedParameters`): `boolean` -Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L42) +Defined in: [src/LayoutManager/LayoutStrategies/LayoutStrategy.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutStrategies/LayoutStrategy.ts#L42) #### Parameters diff --git a/src/content/docs/api/classes/Line.md b/src/content/docs/api/classes/Line.md index 8f8ded9e..5d73b681 100644 --- a/src/content/docs/api/classes/Line.md +++ b/src/content/docs/api/classes/Line.md @@ -5,7 +5,7 @@ prev: false title: "Line" --- -Defined in: [src/shapes/Line.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L35) +Defined in: [src/shapes/Line.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L35) A Class to draw a line A bunch of methods will be added to Polyline to handle the line case @@ -44,7 +44,7 @@ This API is no longer supported and may be removed in a future release. > **new Line**\<`Props`, `SProps`, `EventSpec`\>(`points?`, `options?`): `Line`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Line.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L76) +Defined in: [src/shapes/Line.ts:76](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L76) Constructor @@ -78,7 +78,7 @@ thisArg > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -96,7 +96,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -112,7 +112,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -134,7 +134,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -159,7 +159,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -178,7 +178,7 @@ You can calculate them without updating with [()](/api/classes/line/#calcacoords > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -198,7 +198,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -213,7 +213,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -233,7 +233,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -251,7 +251,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -271,7 +271,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -295,7 +295,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -317,7 +317,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -336,7 +336,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -353,7 +353,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -368,7 +368,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -383,7 +383,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -403,7 +403,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -427,7 +427,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -447,7 +447,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -471,7 +471,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -501,7 +501,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -522,7 +522,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -536,7 +536,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -554,7 +554,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -575,7 +575,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -597,7 +597,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -617,7 +617,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -637,7 +637,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -651,7 +651,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -665,7 +665,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -685,7 +685,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -699,7 +699,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -719,7 +719,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -733,7 +733,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -755,7 +755,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -770,7 +770,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -792,7 +792,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -806,7 +806,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -820,7 +820,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -834,7 +834,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -848,7 +848,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -862,7 +862,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -876,7 +876,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -890,7 +890,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -904,7 +904,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -918,7 +918,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -938,7 +938,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -958,11 +958,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -982,7 +982,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1008,7 +1008,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1025,7 +1025,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1045,7 +1045,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1061,7 +1061,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1077,7 +1077,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1091,7 +1091,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1111,7 +1111,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1125,7 +1125,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1140,7 +1140,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1154,7 +1154,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1174,7 +1174,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1194,7 +1194,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1209,7 +1209,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1228,7 +1228,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1248,7 +1248,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1268,7 +1268,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1288,7 +1288,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1302,7 +1302,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1317,7 +1317,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1338,7 +1338,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1358,7 +1358,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1378,7 +1378,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1398,7 +1398,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1412,7 +1412,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1432,7 +1432,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1465,7 +1465,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1485,7 +1485,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1507,7 +1507,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1527,7 +1527,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1547,7 +1547,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1561,7 +1561,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1575,7 +1575,7 @@ Object width > **x1**: `number` -Defined in: [src/shapes/Line.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L47) +Defined in: [src/shapes/Line.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L47) x value or first line edge @@ -1589,7 +1589,7 @@ x value or first line edge > **x2**: `number` -Defined in: [src/shapes/Line.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L59) +Defined in: [src/shapes/Line.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L59) x value or second line edge @@ -1603,7 +1603,7 @@ x value or second line edge > **y1**: `number` -Defined in: [src/shapes/Line.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L53) +Defined in: [src/shapes/Line.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L53) y value or first line edge @@ -1617,7 +1617,7 @@ y value or first line edge > **y2**: `number` -Defined in: [src/shapes/Line.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L65) +Defined in: [src/shapes/Line.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L65) y value or second line edge @@ -1631,7 +1631,7 @@ y value or second line edge > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Line.ts:233](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L233) +Defined in: [src/shapes/Line.ts:233](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L233) List of attribute names to account for when parsing SVG element (used by [Line.fromElement](/api/classes/line/#fromelement)) @@ -1645,7 +1645,7 @@ http://www.w3.org/TR/SVG/shapes.html#LineElement > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Line.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L69) +Defined in: [src/shapes/Line.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L69) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1662,7 +1662,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1676,7 +1676,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1691,7 +1691,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<[`InteractiveFabricObject`](/api/classes/interactivefabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `interactiveObjectDefaultValues` -Defined in: [src/shapes/Object/InteractiveObject.ts:138](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L138) +Defined in: [src/shapes/Object/InteractiveObject.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L141) #### Inherited from @@ -1703,7 +1703,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:138](https://github.com/fabr > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1719,7 +1719,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Line'` -Defined in: [src/shapes/Line.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L67) +Defined in: [src/shapes/Line.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L67) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1742,7 +1742,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1765,7 +1765,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1787,7 +1787,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -1819,7 +1819,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -1849,7 +1849,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -1867,7 +1867,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -1904,7 +1904,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -1926,7 +1926,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -1952,7 +1952,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -1978,7 +1978,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2005,7 +2005,7 @@ Rendering canvas context > **\_toSVG**(): `string`[] -Defined in: [src/shapes/Line.ts:220](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L220) +Defined in: [src/shapes/Line.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L220) Returns svg representation of an instance @@ -2026,7 +2026,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2048,7 +2048,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2095,7 +2095,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2114,7 +2114,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2135,7 +2135,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2156,7 +2156,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2186,7 +2186,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2212,7 +2212,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2248,7 +2248,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Line`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2274,7 +2274,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2311,7 +2311,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1429) +Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1429) Returns complexity of an instance @@ -2331,7 +2331,7 @@ complexity of this instance (is 1 unless subclassed) > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2359,7 +2359,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2378,7 +2378,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2418,7 +2418,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2448,7 +2448,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2482,7 +2482,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2519,7 +2519,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2553,7 +2553,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2591,7 +2591,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2626,7 +2626,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2658,7 +2658,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2696,7 +2696,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2723,7 +2723,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2751,7 +2751,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -2767,7 +2767,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -2785,7 +2785,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -2806,7 +2806,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -2822,7 +2822,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -2840,7 +2840,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -2858,7 +2858,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -2876,7 +2876,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -2894,7 +2894,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/line/#getpositionbyorigin) @@ -2926,7 +2926,7 @@ use [getPositionByOrigin](/api/classes/line/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/line/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -2964,7 +2964,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -2982,7 +2982,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3001,7 +3001,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/line/ > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3019,7 +3019,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3038,7 +3038,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/line/ > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3062,7 +3062,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3086,7 +3086,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3110,7 +3110,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3134,7 +3134,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3164,7 +3164,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3196,7 +3196,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3214,7 +3214,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3234,7 +3234,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3252,7 +3252,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3270,7 +3270,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3288,7 +3288,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3306,7 +3306,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3334,7 +3334,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3363,7 +3363,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3392,7 +3392,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3420,7 +3420,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3448,7 +3448,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3478,7 +3478,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3506,7 +3506,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3534,7 +3534,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3563,7 +3563,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3588,7 +3588,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3620,7 +3620,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3638,7 +3638,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3659,7 +3659,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3687,7 +3687,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3707,7 +3707,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -3743,7 +3743,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -3769,7 +3769,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -3805,7 +3805,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -3841,7 +3841,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -3865,7 +3865,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -3885,7 +3885,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -3931,7 +3931,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -3965,7 +3965,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4011,7 +4011,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4043,7 +4043,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4076,7 +4076,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4103,7 +4103,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4134,7 +4134,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4160,7 +4160,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4186,7 +4186,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4212,7 +4212,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4238,7 +4238,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4265,7 +4265,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4291,7 +4291,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4317,7 +4317,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4343,7 +4343,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4369,7 +4369,7 @@ New width value > **set**(`key`, `value?`): `Line`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4401,7 +4401,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4428,7 +4428,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4466,7 +4466,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4485,7 +4485,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4506,7 +4506,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4544,7 +4544,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4569,7 +4569,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/line/#s > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/line/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4607,7 +4607,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4632,7 +4632,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/line/ > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4656,7 +4656,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4702,7 +4702,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4726,7 +4726,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -4749,7 +4749,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -4776,7 +4776,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -4808,7 +4808,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -4830,7 +4830,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -4858,7 +4858,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -4890,7 +4890,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -4918,7 +4918,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -4946,7 +4946,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Line`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -4972,7 +4972,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -4992,7 +4992,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Line.ts:166](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L166) +Defined in: [src/shapes/Line.ts:166](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L166) Returns object representation of an instance @@ -5030,7 +5030,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -5048,7 +5048,7 @@ Returns a string representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5080,7 +5080,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5106,7 +5106,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5128,7 +5128,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5166,7 +5166,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5216,7 +5216,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5254,7 +5254,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5277,7 +5277,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5309,7 +5309,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5333,7 +5333,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<`Line`\<\{ \}, [`SerializedLineProps`](/api/interfaces/serializedlineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Line.ts:241](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L241) +Defined in: [src/shapes/Line.ts:241](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L241) Returns Line instance from an SVG element @@ -5365,7 +5365,7 @@ Options object > `static` **fromObject**\<`T`\>(`object`): `Promise`\<`Line`\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedLineProps`](/api/interfaces/serializedlineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Line.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L263) +Defined in: [src/shapes/Line.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L263) Returns Line instance from an object representation @@ -5397,7 +5397,7 @@ Object to create an instance from > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L140) +Defined in: [src/shapes/Object/InteractiveObject.ts:143](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L143) #### Returns diff --git a/src/content/docs/api/classes/Observable.md b/src/content/docs/api/classes/Observable.md index 641f6e82..ea8f733b 100644 --- a/src/content/docs/api/classes/Observable.md +++ b/src/content/docs/api/classes/Observable.md @@ -5,7 +5,7 @@ prev: false title: "Observable" --- -Defined in: [src/Observable.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L11) +Defined in: [src/Observable.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L11) ## See @@ -34,7 +34,7 @@ Defined in: [src/Observable.ts:11](https://github.com/fabricjs/fabric.js/blob/22 > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -70,7 +70,7 @@ Options object > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -102,7 +102,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -134,7 +134,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -154,7 +154,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -170,7 +170,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -212,7 +212,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -242,7 +242,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -284,7 +284,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** diff --git a/src/content/docs/api/classes/Path.md b/src/content/docs/api/classes/Path.md index 21cdb1f8..9c607a88 100644 --- a/src/content/docs/api/classes/Path.md +++ b/src/content/docs/api/classes/Path.md @@ -5,7 +5,7 @@ prev: false title: "Path" --- -Defined in: [src/shapes/Path.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L48) +Defined in: [src/shapes/Path.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L48) Exported so we can tweak default values @@ -33,7 +33,7 @@ Exported so we can tweak default values > **new Path**\<`Props`, `SProps`, `EventSpec`\>(`path`, `options?`): `Path`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Path.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L75) +Defined in: [src/shapes/Path.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L75) Constructor @@ -67,7 +67,7 @@ thisArg > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -85,7 +85,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -101,7 +101,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -123,7 +123,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -148,7 +148,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -167,7 +167,7 @@ You can calculate them without updating with [()](/api/classes/path/#calcacoords > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -187,7 +187,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -202,7 +202,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -222,7 +222,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -240,7 +240,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -260,7 +260,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -284,7 +284,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -306,7 +306,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -325,7 +325,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -342,7 +342,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -357,7 +357,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -372,7 +372,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -392,7 +392,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -416,7 +416,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -436,7 +436,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -460,7 +460,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -490,7 +490,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -511,7 +511,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -525,7 +525,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -543,7 +543,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -564,7 +564,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -586,7 +586,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -606,7 +606,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -626,7 +626,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -640,7 +640,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -654,7 +654,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -674,7 +674,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -688,7 +688,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -708,7 +708,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -722,7 +722,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -744,7 +744,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -759,7 +759,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -781,7 +781,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -795,7 +795,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -809,7 +809,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -823,7 +823,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -837,7 +837,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -851,7 +851,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -865,7 +865,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -879,7 +879,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -893,7 +893,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -907,7 +907,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -927,7 +927,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -947,11 +947,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -971,7 +971,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -997,7 +997,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1014,7 +1014,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1034,7 +1034,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1050,7 +1050,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1066,7 +1066,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1080,7 +1080,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1100,7 +1100,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1114,7 +1114,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1129,7 +1129,7 @@ Used to keep the original parent ref when the object has been added to an Active > **path**: [`TSimplePathData`](/api/type-aliases/tsimplepathdata/) -Defined in: [src/shapes/Path.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L57) +Defined in: [src/shapes/Path.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L57) Array of path points @@ -1139,7 +1139,7 @@ Array of path points > **pathOffset**: [`Point`](/api/classes/point/) -Defined in: [src/shapes/Path.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L59) +Defined in: [src/shapes/Path.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L59) *** @@ -1147,7 +1147,7 @@ Defined in: [src/shapes/Path.ts:59](https://github.com/fabricjs/fabric.js/blob/2 > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1161,7 +1161,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1181,7 +1181,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1201,7 +1201,7 @@ Object scale factor (vertical) > `optional` **segmentsInfo**: [`TPathSegmentInfo`](/api/type-aliases/tpathsegmentinfo/)[] -Defined in: [src/shapes/Path.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L63) +Defined in: [src/shapes/Path.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L63) *** @@ -1209,7 +1209,7 @@ Defined in: [src/shapes/Path.ts:63](https://github.com/fabricjs/fabric.js/blob/2 > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1224,7 +1224,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1243,7 +1243,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1263,7 +1263,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1283,7 +1283,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1303,7 +1303,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1317,7 +1317,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1332,7 +1332,7 @@ When undefined, the snapThreshold will default to the snapAngle. > `optional` **sourcePath**: `string` -Defined in: [src/shapes/Path.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L61) +Defined in: [src/shapes/Path.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L61) *** @@ -1340,7 +1340,7 @@ Defined in: [src/shapes/Path.ts:61](https://github.com/fabricjs/fabric.js/blob/2 > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1361,7 +1361,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1381,7 +1381,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1401,7 +1401,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1421,7 +1421,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1435,7 +1435,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1455,7 +1455,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1488,7 +1488,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1508,7 +1508,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1530,7 +1530,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1550,7 +1550,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1570,7 +1570,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1584,7 +1584,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1598,7 +1598,7 @@ Object width > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Path.ts:371](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L371) +Defined in: [src/shapes/Path.ts:371](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L371) List of attribute names to account for when parsing SVG element (used by `Path.fromElement`) @@ -1612,7 +1612,7 @@ http://www.w3.org/TR/SVG/paths.html#PathElement > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Path.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L67) +Defined in: [src/shapes/Path.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L67) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1629,7 +1629,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1643,7 +1643,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1658,7 +1658,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<[`InteractiveFabricObject`](/api/classes/interactivefabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `interactiveObjectDefaultValues` -Defined in: [src/shapes/Object/InteractiveObject.ts:138](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L138) +Defined in: [src/shapes/Object/InteractiveObject.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L141) #### Inherited from @@ -1670,7 +1670,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:138](https://github.com/fabr > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1686,7 +1686,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Path'` -Defined in: [src/shapes/Path.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L65) +Defined in: [src/shapes/Path.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L65) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1709,7 +1709,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1732,7 +1732,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1754,7 +1754,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_calcBoundsFromPath**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Path.ts:284](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L284) +Defined in: [src/shapes/Path.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L284) #### Returns @@ -1766,7 +1766,7 @@ Defined in: [src/shapes/Path.ts:284](https://github.com/fabricjs/fabric.js/blob/ > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -1798,7 +1798,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -1828,7 +1828,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -1846,7 +1846,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -1883,7 +1883,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -1905,7 +1905,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -1931,7 +1931,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -1957,7 +1957,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -1984,7 +1984,7 @@ Rendering canvas context > **\_toSVG**(): `string`[] -Defined in: [src/shapes/Path.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L215) +Defined in: [src/shapes/Path.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L215) Returns svg representation of an instance @@ -2005,7 +2005,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2027,7 +2027,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2074,7 +2074,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2093,7 +2093,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2114,7 +2114,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2135,7 +2135,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2165,7 +2165,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2191,7 +2191,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2227,7 +2227,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Path`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2253,7 +2253,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2290,7 +2290,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Path.ts:268](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L268) +Defined in: [src/shapes/Path.ts:268](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L268) Returns number representation of an instance complexity @@ -2310,7 +2310,7 @@ complexity of this instance > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2338,7 +2338,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2357,7 +2357,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2397,7 +2397,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2427,7 +2427,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2461,7 +2461,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2498,7 +2498,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2532,7 +2532,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2570,7 +2570,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2605,7 +2605,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2637,7 +2637,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2675,7 +2675,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2702,7 +2702,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2730,7 +2730,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -2746,7 +2746,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -2764,7 +2764,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -2785,7 +2785,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -2801,7 +2801,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -2819,7 +2819,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -2837,7 +2837,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -2855,7 +2855,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -2873,7 +2873,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/path/#getpositionbyorigin) @@ -2905,7 +2905,7 @@ use [getPositionByOrigin](/api/classes/path/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/path/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -2943,7 +2943,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -2961,7 +2961,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -2980,7 +2980,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/path/ > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -2998,7 +2998,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3017,7 +3017,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/path/ > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3041,7 +3041,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3065,7 +3065,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3089,7 +3089,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3113,7 +3113,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3143,7 +3143,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3175,7 +3175,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3193,7 +3193,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3213,7 +3213,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3231,7 +3231,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3249,7 +3249,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3267,7 +3267,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3285,7 +3285,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3313,7 +3313,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3342,7 +3342,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3371,7 +3371,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3399,7 +3399,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3427,7 +3427,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3457,7 +3457,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3485,7 +3485,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3513,7 +3513,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3542,7 +3542,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3567,7 +3567,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3599,7 +3599,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3617,7 +3617,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3638,7 +3638,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3666,7 +3666,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3686,7 +3686,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -3722,7 +3722,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -3748,7 +3748,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -3784,7 +3784,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -3820,7 +3820,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -3844,7 +3844,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -3864,7 +3864,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -3910,7 +3910,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -3944,7 +3944,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -3990,7 +3990,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4022,7 +4022,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4055,7 +4055,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4082,7 +4082,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4113,7 +4113,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4139,7 +4139,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4165,7 +4165,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4191,7 +4191,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4217,7 +4217,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4244,7 +4244,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4270,7 +4270,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4296,7 +4296,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4322,7 +4322,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4348,7 +4348,7 @@ New width value > **set**(`key`, `value?`): `Path`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4380,7 +4380,7 @@ Property value (if function, the value is passed into it and its return value is > **setBoundingBox**(`adjustPosition?`): `void` -Defined in: [src/shapes/Path.ts:276](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L276) +Defined in: [src/shapes/Path.ts:276](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L276) #### Parameters @@ -4398,7 +4398,7 @@ Defined in: [src/shapes/Path.ts:276](https://github.com/fabricjs/fabric.js/blob/ > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4425,7 +4425,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4463,7 +4463,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4482,7 +4482,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setDimensions**(): `void` -Defined in: [src/shapes/Path.ts:272](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L272) +Defined in: [src/shapes/Path.ts:272](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L272) #### Returns @@ -4494,7 +4494,7 @@ Defined in: [src/shapes/Path.ts:272](https://github.com/fabricjs/fabric.js/blob/ > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4515,7 +4515,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4553,7 +4553,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4578,7 +4578,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/path/#s > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/path/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4616,7 +4616,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4641,7 +4641,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/path/ > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4665,7 +4665,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4711,7 +4711,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4735,7 +4735,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -4758,7 +4758,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -4785,7 +4785,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -4817,7 +4817,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -4839,7 +4839,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -4867,7 +4867,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`reviver?`): `string` -Defined in: [src/shapes/Path.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L240) +Defined in: [src/shapes/Path.ts:240](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L240) Returns svg clipPath representation of an instance @@ -4895,7 +4895,7 @@ svg representation of an instance > **toDatalessObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Path.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L198) +Defined in: [src/shapes/Path.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L198) Returns dataless object representation of an instance @@ -4933,7 +4933,7 @@ object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -4961,7 +4961,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Path`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -4987,7 +4987,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5007,7 +5007,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Path.ts:183](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L183) +Defined in: [src/shapes/Path.ts:183](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L183) Returns object representation of an instance @@ -5045,7 +5045,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Path.ts:172](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L172) +Defined in: [src/shapes/Path.ts:172](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L172) Returns string representation of an instance @@ -5065,7 +5065,7 @@ string representation of an instance > **toSVG**(`reviver?`): `string` -Defined in: [src/shapes/Path.ts:256](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L256) +Defined in: [src/shapes/Path.ts:256](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L256) Returns svg representation of an instance @@ -5093,7 +5093,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5119,7 +5119,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5141,7 +5141,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5179,7 +5179,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5229,7 +5229,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5267,7 +5267,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5290,7 +5290,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5322,7 +5322,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5346,7 +5346,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<`Path`\<\{ `absolutePositioned`: `boolean`; `angle`: [`TDegree`](/api/type-aliases/tdegree/); `backgroundColor`: `string`; `borderColor`: `string`; `borderDashArray`: `null` \| `number`[]; `borderOpacityWhenMoving`: `number`; `borderScaleFactor`: `number`; `canvas`: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\>; `centeredRotation`: `boolean`; `centeredScaling`: `boolean`; `clipPath`: [`BaseFabricObject`](/api/classes/basefabricobject/); `cornerColor`: `string`; `cornerDashArray`: `null` \| `number`[]; `cornerSize`: `number`; `cornerStrokeColor`: `string`; `cornerStyle`: `"circle"` \| `"rect"`; `evented`: `boolean`; `excludeFromExport`: `boolean`; `fill`: `null` \| `string` \| [`Gradient`](/api/classes/gradient/)\<`"linear"`, `"linear"`\> \| [`Gradient`](/api/classes/gradient/)\<`"radial"`, `"radial"`\> \| [`Pattern`](/api/classes/pattern/); `fillRule`: `"evenodd"` \| `"nonzero"`; `flipX`: `boolean`; `flipY`: `boolean`; `globalCompositeOperation`: `"color"` \| `"color-burn"` \| `"color-dodge"` \| `"copy"` \| `"darken"` \| `"destination-atop"` \| `"destination-in"` \| `"destination-out"` \| `"destination-over"` \| `"difference"` \| `"exclusion"` \| `"hard-light"` \| `"hue"` \| `"lighten"` \| `"lighter"` \| `"luminosity"` \| `"multiply"` \| `"overlay"` \| `"saturation"` \| `"screen"` \| `"soft-light"` \| `"source-atop"` \| `"source-in"` \| `"source-out"` \| `"source-over"` \| `"xor"`; `hasBorders`: `boolean`; `hasControls`: `boolean`; `height`: `number`; `hoverCursor`: `null` \| `string`; `includeDefaultValues`: `boolean`; `inverted`: `boolean`; `left`: `undefined`; `lockMovementX`: `boolean`; `lockMovementY`: `boolean`; `lockRotation`: `boolean`; `lockScalingFlip`: `boolean`; `lockScalingX`: `boolean`; `lockScalingY`: `boolean`; `lockSkewingX`: `boolean`; `lockSkewingY`: `boolean`; `minScaleLimit`: `number`; `moveCursor`: `null` \| `string`; `noScaleCache`: `boolean`; `objectCaching`: `boolean`; `opacity`: `number`; `originX`: `number` \| `"center"` \| `"left"` \| `"right"`; `originY`: `number` \| `"center"` \| `"top"` \| `"bottom"`; `padding`: `number`; `paintFirst`: `"fill"` \| `"stroke"`; `path`: [`TSimplePathData`](/api/type-aliases/tsimplepathdata/); `perPixelTargetFind`: `boolean`; `scaleX`: `number`; `scaleY`: `number`; `selectable`: `boolean`; `selectionBackgroundColor`: `string`; `shadow`: `null` \| [`Shadow`](/api/classes/shadow/); `skewX`: [`TDegree`](/api/type-aliases/tdegree/); `skewY`: [`TDegree`](/api/type-aliases/tdegree/); `snapAngle`: [`TDegree`](/api/type-aliases/tdegree/); `snapThreshold`: [`TDegree`](/api/type-aliases/tdegree/); `sourcePath`: `string`; `stroke`: `null` \| `string` \| [`Gradient`](/api/classes/gradient/)\<`"linear"`, `"linear"`\> \| [`Gradient`](/api/classes/gradient/)\<`"radial"`, `"radial"`\> \| [`Pattern`](/api/classes/pattern/); `strokeDashArray`: `null` \| `number`[]; `strokeDashOffset`: `number`; `strokeLineCap`: `"square"` \| `"butt"` \| `"round"`; `strokeLineJoin`: `"round"` \| `"bevel"` \| `"miter"`; `strokeMiterLimit`: `number`; `strokeUniform`: `boolean`; `strokeWidth`: `number`; `top`: `undefined`; `touchCornerSize`: `number`; `transparentCorners`: `boolean`; `visible`: `boolean`; `width`: `number`; \}, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Path.ts:389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L389) +Defined in: [src/shapes/Path.ts:389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L389) Creates an instance of Path from an SVG element @@ -5378,7 +5378,7 @@ Options object > `static` **fromObject**\<`T`\>(`object`): `Promise`\<`Path`\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Path.ts:378](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L378) +Defined in: [src/shapes/Path.ts:378](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L378) Creates an instance of Path from an object @@ -5408,7 +5408,7 @@ Creates an instance of Path from an object > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L140) +Defined in: [src/shapes/Object/InteractiveObject.ts:143](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L143) #### Returns diff --git a/src/content/docs/api/classes/Pattern.md b/src/content/docs/api/classes/Pattern.md index 2fab3b11..770e8d78 100644 --- a/src/content/docs/api/classes/Pattern.md +++ b/src/content/docs/api/classes/Pattern.md @@ -5,7 +5,7 @@ prev: false title: "Pattern" --- -Defined in: [src/Pattern/Pattern.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L21) +Defined in: [src/Pattern/Pattern.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L21) ## See @@ -18,7 +18,7 @@ Defined in: [src/Pattern/Pattern.ts:21](https://github.com/fabricjs/fabric.js/bl > **new Pattern**(`options?`): `Pattern` -Defined in: [src/Pattern/Pattern.ts:92](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L92) +Defined in: [src/Pattern/Pattern.ts:92](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L92) Constructor @@ -40,7 +40,7 @@ Options object > **crossOrigin**: [`TCrossOrigin`](/api/type-aliases/tcrossorigin/) = `''` -Defined in: [src/Pattern/Pattern.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L61) +Defined in: [src/Pattern/Pattern.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L61) *** @@ -48,7 +48,7 @@ Defined in: [src/Pattern/Pattern.ts:61](https://github.com/fabricjs/fabric.js/bl > `optional` **excludeFromExport**: `boolean` -Defined in: [src/Pattern/Pattern.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L79) +Defined in: [src/Pattern/Pattern.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L79) If true, this object will not be exported during the serialization of a canvas @@ -58,7 +58,7 @@ If true, this object will not be exported during the serialization of a canvas > `readonly` **id**: `number` -Defined in: [src/Pattern/Pattern.ts:85](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L85) +Defined in: [src/Pattern/Pattern.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L85) ID used for SVG export functionalities @@ -68,7 +68,7 @@ ID used for SVG export functionalities > **offsetX**: `number` = `0` -Defined in: [src/Pattern/Pattern.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L50) +Defined in: [src/Pattern/Pattern.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L50) Pattern horizontal offset from object's left/top corner @@ -78,7 +78,7 @@ Pattern horizontal offset from object's left/top corner > **offsetY**: `number` = `0` -Defined in: [src/Pattern/Pattern.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L56) +Defined in: [src/Pattern/Pattern.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L56) Pattern vertical offset from object's left/top corner @@ -88,7 +88,7 @@ Pattern vertical offset from object's left/top corner > `optional` **patternTransform**: [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/Pattern/Pattern.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L68) +Defined in: [src/Pattern/Pattern.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L68) transform matrix to change the pattern, imported from svgs. @@ -102,7 +102,7 @@ verify if using the identity matrix as default makes the rest of the code more e > **repeat**: [`PatternRepeat`](/api/type-aliases/patternrepeat/) = `'repeat'` -Defined in: [src/Pattern/Pattern.ts:44](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L44) +Defined in: [src/Pattern/Pattern.ts:44](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L44) #### Defaults @@ -112,7 +112,7 @@ Defined in: [src/Pattern/Pattern.ts:44](https://github.com/fabricjs/fabric.js/bl > **source**: `CanvasImageSource` -Defined in: [src/Pattern/Pattern.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L73) +Defined in: [src/Pattern/Pattern.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L73) The actual pixel source of the pattern @@ -122,7 +122,7 @@ The actual pixel source of the pattern > `static` **type**: `string` = `'Pattern'` -Defined in: [src/Pattern/Pattern.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L22) +Defined in: [src/Pattern/Pattern.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L22) ## Accessors @@ -132,7 +132,7 @@ Defined in: [src/Pattern/Pattern.ts:22](https://github.com/fabricjs/fabric.js/bl > **get** **type**(): `string` -Defined in: [src/Pattern/Pattern.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L32) +Defined in: [src/Pattern/Pattern.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L32) Legacy identifier of the class. Prefer using this.constructor.type 'Pattern' or utils like isPattern, or instance of to indentify a pattern in your code. @@ -154,7 +154,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/Pattern/Pattern.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L36) +Defined in: [src/Pattern/Pattern.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L36) ##### Parameters @@ -172,7 +172,7 @@ Defined in: [src/Pattern/Pattern.ts:36](https://github.com/fabricjs/fabric.js/bl > **isCanvasSource**(): `this is { source: HTMLCanvasElement }` -Defined in: [src/Pattern/Pattern.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L109) +Defined in: [src/Pattern/Pattern.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L109) #### Returns @@ -186,7 +186,7 @@ true if [source](/api/classes/pattern/#source) is a element > **isImageSource**(): `this is { source: HTMLImageElement }` -Defined in: [src/Pattern/Pattern.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L100) +Defined in: [src/Pattern/Pattern.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L100) #### Returns @@ -200,7 +200,7 @@ true if [source](/api/classes/pattern/#source) is an element > **sourceToString**(): `string` -Defined in: [src/Pattern/Pattern.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L113) +Defined in: [src/Pattern/Pattern.ts:113](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L113) #### Returns @@ -212,7 +212,7 @@ Defined in: [src/Pattern/Pattern.ts:113](https://github.com/fabricjs/fabric.js/b > **toLive**(`ctx`): `null` \| `CanvasPattern` -Defined in: [src/Pattern/Pattern.ts:126](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L126) +Defined in: [src/Pattern/Pattern.ts:126](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L126) Returns an instance of CanvasPattern @@ -234,7 +234,7 @@ Context to create pattern > **toObject**(`propertiesToInclude?`): `Record`\<`string`, `any`\> -Defined in: [src/Pattern/Pattern.ts:147](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L147) +Defined in: [src/Pattern/Pattern.ts:147](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L147) Returns object representation of a pattern @@ -258,7 +258,7 @@ Object representation of a pattern instance > **toSVG**(`__namedParameters`): `string` -Defined in: [src/Pattern/Pattern.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L167) +Defined in: [src/Pattern/Pattern.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L167) Returns SVG representation of a pattern @@ -278,7 +278,7 @@ Returns SVG representation of a pattern > `static` **fromObject**(`__namedParameters`, `options?`): `Promise`\<`Pattern`\> -Defined in: [src/Pattern/Pattern.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/Pattern.ts#L193) +Defined in: [src/Pattern/Pattern.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/Pattern.ts#L193) #### Parameters diff --git a/src/content/docs/api/classes/PatternBrush.md b/src/content/docs/api/classes/PatternBrush.md index b6fcece6..8672e7e8 100644 --- a/src/content/docs/api/classes/PatternBrush.md +++ b/src/content/docs/api/classes/PatternBrush.md @@ -5,7 +5,7 @@ prev: false title: "PatternBrush" --- -Defined in: [src/brushes/PatternBrush.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PatternBrush.ts#L7) +Defined in: [src/brushes/PatternBrush.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PatternBrush.ts#L7) ## See @@ -21,7 +21,7 @@ Defined in: [src/brushes/PatternBrush.ts:7](https://github.com/fabricjs/fabric.j > **new PatternBrush**(`canvas`): `PatternBrush` -Defined in: [src/brushes/PatternBrush.ts:10](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PatternBrush.ts#L10) +Defined in: [src/brushes/PatternBrush.ts:10](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PatternBrush.ts#L10) #### Parameters @@ -43,7 +43,7 @@ Defined in: [src/brushes/PatternBrush.ts:10](https://github.com/fabricjs/fabric. > **canvas**: [`Canvas`](/api/classes/canvas/) -Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L66) +Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L66) #### Todo @@ -59,7 +59,7 @@ add type > **color**: `string` = `'rgb(0, 0, 0)'` -Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L15) +Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L15) Color of a brush @@ -73,7 +73,7 @@ Color of a brush > **decimate**: `number` = `0.4` -Defined in: [src/brushes/PencilBrush.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L25) +Defined in: [src/brushes/PencilBrush.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L25) Discard points that are less than `decimate` pixel distant from each other @@ -93,7 +93,7 @@ Discard points that are less than `decimate` pixel distant from each other > **drawStraightLine**: `boolean` = `false` -Defined in: [src/brushes/PencilBrush.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L34) +Defined in: [src/brushes/PencilBrush.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L34) Draws a straight line between last recorded point to current pointer Used for `shift` functionality @@ -114,7 +114,7 @@ false > **limitedToCanvasSize**: `boolean` = `false` -Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L61) +Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L61) When `true`, the free drawing is limited to the whiteboard size. Default to false. @@ -134,7 +134,7 @@ false > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) = `null` -Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L29) +Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L29) Shadow object representing shadow of this shape. Backwards incompatibility note: This property replaces "shadowColor" (String), "shadowOffsetX" (Number), @@ -150,7 +150,7 @@ Shadow object representing shadow of this shape. > `optional` **source**: `CanvasImageSource` -Defined in: [src/brushes/PatternBrush.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PatternBrush.ts#L8) +Defined in: [src/brushes/PatternBrush.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PatternBrush.ts#L8) *** @@ -158,7 +158,7 @@ Defined in: [src/brushes/PatternBrush.ts:8](https://github.com/fabricjs/fabric.j > **straightLineKey**: `undefined` \| `null` \| `"altKey"` \| `"ctrlKey"` \| `"metaKey"` \| `"shiftKey"` = `'shiftKey'` -Defined in: [src/brushes/PencilBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L41) +Defined in: [src/brushes/PencilBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L41) The event modifier key that makes the brush draw a straight line. If `null` or 'none' or any other string that is not a modifier key the feature is disabled. @@ -173,7 +173,7 @@ If `null` or 'none' or any other string that is not a modifier key the feature i > **strokeDashArray**: `null` \| `number`[] = `null` -Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L53) +Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L53) Stroke Dash Array. @@ -187,7 +187,7 @@ Stroke Dash Array. > **strokeLineCap**: `CanvasLineCap` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L35) +Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L35) Line endings style of a brush (one of "butt", "round", "square") @@ -201,7 +201,7 @@ Line endings style of a brush (one of "butt", "round", "square") > **strokeLineJoin**: `CanvasLineJoin` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L41) +Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L41) Corner style of a brush (one of "bevel", "round", "miter") @@ -215,7 +215,7 @@ Corner style of a brush (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` = `10` -Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L47) +Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L47) Maximum miter length (used for strokeLineJoin = "miter") of a brush's @@ -229,7 +229,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of a brush's > **width**: `number` = `1` -Defined in: [src/brushes/BaseBrush.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L21) +Defined in: [src/brushes/BaseBrush.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L21) Width of a brush, has to be a Number, no string literals @@ -243,7 +243,7 @@ Width of a brush, has to be a Number, no string literals > **\_finalizeAndAddPath**(): `void` -Defined in: [src/brushes/PencilBrush.ts:275](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L275) +Defined in: [src/brushes/PencilBrush.ts:275](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L275) On mouseup after drawing the path on contextTop canvas we use the points captured to create an new Path object @@ -263,7 +263,7 @@ and add it to the canvas. > **\_setBrushStyles**(`ctx`): `void` -Defined in: [src/brushes/PatternBrush.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PatternBrush.ts#L50) +Defined in: [src/brushes/PatternBrush.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PatternBrush.ts#L50) Sets brush styles @@ -287,7 +287,7 @@ Sets brush styles > **convertPointsToSVGPath**(`points`): [`TSimplePathData`](/api/type-aliases/tsimplepathdata/) -Defined in: [src/brushes/PencilBrush.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L213) +Defined in: [src/brushes/PencilBrush.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L213) Converts points to SVG path @@ -315,7 +315,7 @@ SVG path commands > **createPath**(`pathData`): [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/brushes/PatternBrush.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PatternBrush.ts#L59) +Defined in: [src/brushes/PatternBrush.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PatternBrush.ts#L59) Creates path @@ -339,7 +339,7 @@ Creates path > **decimatePoints**(`points`, `distance`): [`Point`](/api/classes/point/)[] -Defined in: [src/brushes/PencilBrush.ts:244](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L244) +Defined in: [src/brushes/PencilBrush.ts:244](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L244) Decimate points array with the decimate value @@ -367,7 +367,7 @@ Decimate points array with the decimate value > **getPattern**(`ctx`): `null` \| `CanvasPattern` -Defined in: [src/brushes/PatternBrush.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PatternBrush.ts#L42) +Defined in: [src/brushes/PatternBrush.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PatternBrush.ts#L42) Creates "pattern" instance property @@ -387,7 +387,7 @@ Creates "pattern" instance property > **getPatternSrc**(): `HTMLCanvasElement` -Defined in: [src/brushes/PatternBrush.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PatternBrush.ts#L14) +Defined in: [src/brushes/PatternBrush.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PatternBrush.ts#L14) #### Returns @@ -399,7 +399,7 @@ Defined in: [src/brushes/PatternBrush.ts:14](https://github.com/fabricjs/fabric. > **needsFullRender**(): `boolean` -Defined in: [src/brushes/PencilBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L53) +Defined in: [src/brushes/PencilBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L53) #### Returns @@ -415,7 +415,7 @@ Defined in: [src/brushes/PencilBrush.ts:53](https://github.com/fabricjs/fabric.j > **onMouseDown**(`pointer`, `__namedParameters`): `void` -Defined in: [src/brushes/PencilBrush.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L67) +Defined in: [src/brushes/PencilBrush.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L67) Invoked on mouse down @@ -443,7 +443,7 @@ Invoked on mouse down > **onMouseMove**(`pointer`, `__namedParameters`): `void` -Defined in: [src/brushes/PencilBrush.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L83) +Defined in: [src/brushes/PencilBrush.ts:83](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L83) Invoked on mouse move @@ -471,7 +471,7 @@ Invoked on mouse move > **onMouseUp**(`__namedParameters`): `boolean` -Defined in: [src/brushes/PencilBrush.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L121) +Defined in: [src/brushes/PencilBrush.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L121) Invoked on mouse up @@ -495,7 +495,7 @@ Invoked on mouse up > `static` **drawSegment**(`ctx`, `p1`, `p2`): [`Point`](/api/classes/point/) -Defined in: [src/brushes/PencilBrush.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L57) +Defined in: [src/brushes/PencilBrush.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L57) #### Parameters diff --git a/src/content/docs/api/classes/PencilBrush.md b/src/content/docs/api/classes/PencilBrush.md index 020f2d39..b4dd9767 100644 --- a/src/content/docs/api/classes/PencilBrush.md +++ b/src/content/docs/api/classes/PencilBrush.md @@ -5,7 +5,7 @@ prev: false title: "PencilBrush" --- -Defined in: [src/brushes/PencilBrush.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L19) +Defined in: [src/brushes/PencilBrush.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L19) ## See @@ -25,7 +25,7 @@ Defined in: [src/brushes/PencilBrush.ts:19](https://github.com/fabricjs/fabric.j > **new PencilBrush**(`canvas`): `PencilBrush` -Defined in: [src/brushes/PencilBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L47) +Defined in: [src/brushes/PencilBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L47) #### Parameters @@ -47,7 +47,7 @@ Defined in: [src/brushes/PencilBrush.ts:47](https://github.com/fabricjs/fabric.j > **canvas**: [`Canvas`](/api/classes/canvas/) -Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L66) +Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L66) #### Todo @@ -63,7 +63,7 @@ add type > **color**: `string` = `'rgb(0, 0, 0)'` -Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L15) +Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L15) Color of a brush @@ -77,7 +77,7 @@ Color of a brush > **decimate**: `number` = `0.4` -Defined in: [src/brushes/PencilBrush.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L25) +Defined in: [src/brushes/PencilBrush.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L25) Discard points that are less than `decimate` pixel distant from each other @@ -93,7 +93,7 @@ Discard points that are less than `decimate` pixel distant from each other > **drawStraightLine**: `boolean` = `false` -Defined in: [src/brushes/PencilBrush.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L34) +Defined in: [src/brushes/PencilBrush.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L34) Draws a straight line between last recorded point to current pointer Used for `shift` functionality @@ -110,7 +110,7 @@ false > **limitedToCanvasSize**: `boolean` = `false` -Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L61) +Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L61) When `true`, the free drawing is limited to the whiteboard size. Default to false. @@ -130,7 +130,7 @@ false > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) = `null` -Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L29) +Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L29) Shadow object representing shadow of this shape. Backwards incompatibility note: This property replaces "shadowColor" (String), "shadowOffsetX" (Number), @@ -146,7 +146,7 @@ Shadow object representing shadow of this shape. > **straightLineKey**: `undefined` \| `null` \| `"altKey"` \| `"ctrlKey"` \| `"metaKey"` \| `"shiftKey"` = `'shiftKey'` -Defined in: [src/brushes/PencilBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L41) +Defined in: [src/brushes/PencilBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L41) The event modifier key that makes the brush draw a straight line. If `null` or 'none' or any other string that is not a modifier key the feature is disabled. @@ -157,7 +157,7 @@ If `null` or 'none' or any other string that is not a modifier key the feature i > **strokeDashArray**: `null` \| `number`[] = `null` -Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L53) +Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L53) Stroke Dash Array. @@ -171,7 +171,7 @@ Stroke Dash Array. > **strokeLineCap**: `CanvasLineCap` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L35) +Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L35) Line endings style of a brush (one of "butt", "round", "square") @@ -185,7 +185,7 @@ Line endings style of a brush (one of "butt", "round", "square") > **strokeLineJoin**: `CanvasLineJoin` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L41) +Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L41) Corner style of a brush (one of "bevel", "round", "miter") @@ -199,7 +199,7 @@ Corner style of a brush (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` = `10` -Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L47) +Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L47) Maximum miter length (used for strokeLineJoin = "miter") of a brush's @@ -213,7 +213,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of a brush's > **width**: `number` = `1` -Defined in: [src/brushes/BaseBrush.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L21) +Defined in: [src/brushes/BaseBrush.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L21) Width of a brush, has to be a Number, no string literals @@ -227,7 +227,7 @@ Width of a brush, has to be a Number, no string literals > **\_finalizeAndAddPath**(): `void` -Defined in: [src/brushes/PencilBrush.ts:275](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L275) +Defined in: [src/brushes/PencilBrush.ts:275](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L275) On mouseup after drawing the path on contextTop canvas we use the points captured to create an new Path object @@ -243,7 +243,7 @@ and add it to the canvas. > **convertPointsToSVGPath**(`points`): [`TSimplePathData`](/api/type-aliases/tsimplepathdata/) -Defined in: [src/brushes/PencilBrush.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L213) +Defined in: [src/brushes/PencilBrush.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L213) Converts points to SVG path @@ -267,7 +267,7 @@ SVG path commands > **createPath**(`pathData`): [`Path`](/api/classes/path/) -Defined in: [src/brushes/PencilBrush.ts:223](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L223) +Defined in: [src/brushes/PencilBrush.ts:223](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L223) Creates a Path object to add on canvas @@ -291,7 +291,7 @@ Path to add on canvas > **decimatePoints**(`points`, `distance`): [`Point`](/api/classes/point/)[] -Defined in: [src/brushes/PencilBrush.ts:244](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L244) +Defined in: [src/brushes/PencilBrush.ts:244](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L244) Decimate points array with the decimate value @@ -315,7 +315,7 @@ Decimate points array with the decimate value > **needsFullRender**(): `boolean` -Defined in: [src/brushes/PencilBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L53) +Defined in: [src/brushes/PencilBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L53) #### Returns @@ -331,7 +331,7 @@ Defined in: [src/brushes/PencilBrush.ts:53](https://github.com/fabricjs/fabric.j > **onMouseDown**(`pointer`, `__namedParameters`): `void` -Defined in: [src/brushes/PencilBrush.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L67) +Defined in: [src/brushes/PencilBrush.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L67) Invoked on mouse down @@ -359,7 +359,7 @@ Invoked on mouse down > **onMouseMove**(`pointer`, `__namedParameters`): `void` -Defined in: [src/brushes/PencilBrush.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L83) +Defined in: [src/brushes/PencilBrush.ts:83](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L83) Invoked on mouse move @@ -387,7 +387,7 @@ Invoked on mouse move > **onMouseUp**(`__namedParameters`): `boolean` -Defined in: [src/brushes/PencilBrush.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L121) +Defined in: [src/brushes/PencilBrush.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L121) Invoked on mouse up @@ -411,7 +411,7 @@ Invoked on mouse up > `static` **drawSegment**(`ctx`, `p1`, `p2`): [`Point`](/api/classes/point/) -Defined in: [src/brushes/PencilBrush.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/PencilBrush.ts#L57) +Defined in: [src/brushes/PencilBrush.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/PencilBrush.ts#L57) #### Parameters diff --git a/src/content/docs/api/classes/Point.md b/src/content/docs/api/classes/Point.md index b297033d..17b059ff 100644 --- a/src/content/docs/api/classes/Point.md +++ b/src/content/docs/api/classes/Point.md @@ -5,7 +5,7 @@ prev: false title: "Point" --- -Defined in: [src/Point.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L13) +Defined in: [src/Point.ts:13](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L13) Adaptation of work of Kevin Lindsey(kevin@kevlindev.com) @@ -19,7 +19,7 @@ Adaptation of work of Kevin Lindsey(kevin@kevlindev.com) > **new Point**(): `Point` -Defined in: [src/Point.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L18) +Defined in: [src/Point.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L18) #### Returns @@ -29,7 +29,7 @@ Defined in: [src/Point.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda45 > **new Point**(`x`, `y`): `Point` -Defined in: [src/Point.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L19) +Defined in: [src/Point.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L19) #### Parameters @@ -49,7 +49,7 @@ Defined in: [src/Point.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda45 > **new Point**(`point?`): `Point` -Defined in: [src/Point.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L20) +Defined in: [src/Point.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L20) #### Parameters @@ -67,7 +67,7 @@ Defined in: [src/Point.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda45 > **x**: `number` -Defined in: [src/Point.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L14) +Defined in: [src/Point.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L14) #### Implementation of @@ -79,7 +79,7 @@ Defined in: [src/Point.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda45 > **y**: `number` -Defined in: [src/Point.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L16) +Defined in: [src/Point.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L16) #### Implementation of @@ -91,7 +91,7 @@ Defined in: [src/Point.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda45 > **add**(`that`): `Point` -Defined in: [src/Point.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L36) +Defined in: [src/Point.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L36) Adds another point to this one and returns a new one with the sum @@ -113,7 +113,7 @@ new Point instance with added values > **addEquals**(`that`): `Point` -Defined in: [src/Point.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L46) +Defined in: [src/Point.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L46) Adds another point to this one @@ -139,7 +139,7 @@ thisArg > **clone**(): `Point` -Defined in: [src/Point.ts:337](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L337) +Defined in: [src/Point.ts:337](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L337) return a cloned instance of the point @@ -153,7 +153,7 @@ return a cloned instance of the point > **distanceFrom**(`that`): `number` -Defined in: [src/Point.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L240) +Defined in: [src/Point.ts:240](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L240) Returns distance from this point and another one @@ -173,7 +173,7 @@ Returns distance from this point and another one > **divide**(`that`): `Point` -Defined in: [src/Point.ts:150](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L150) +Defined in: [src/Point.ts:150](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L150) Divides this point by another and returns a new one @@ -193,7 +193,7 @@ Divides this point by another and returns a new one > **eq**(`that`): `boolean` -Defined in: [src/Point.ts:180](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L180) +Defined in: [src/Point.ts:180](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L180) Returns true if this point is equal to another one @@ -213,7 +213,7 @@ Returns true if this point is equal to another one > **gt**(`that`): `boolean` -Defined in: [src/Point.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L208) +Defined in: [src/Point.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L208) Returns true if this point is greater another one @@ -233,7 +233,7 @@ Returns true if this point is greater another one > **gte**(`that`): `boolean` -Defined in: [src/Point.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L217) +Defined in: [src/Point.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L217) Returns true if this point is greater than or equal to another one @@ -253,7 +253,7 @@ Returns true if this point is greater than or equal to another one > **lerp**(`that`, `t`): `Point` -Defined in: [src/Point.ts:227](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L227) +Defined in: [src/Point.ts:227](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L227) Returns new point which is the result of linear interpolation with this one and another one @@ -279,7 +279,7 @@ Returns new point which is the result of linear interpolation with this one and > **lt**(`that`): `boolean` -Defined in: [src/Point.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L189) +Defined in: [src/Point.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L189) Returns true if this point is less than another one @@ -299,7 +299,7 @@ Returns true if this point is less than another one > **lte**(`that`): `boolean` -Defined in: [src/Point.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L198) +Defined in: [src/Point.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L198) Returns true if this point is less than or equal to another one @@ -319,7 +319,7 @@ Returns true if this point is less than or equal to another one > **max**(`that`): `Point` -Defined in: [src/Point.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L269) +Defined in: [src/Point.ts:269](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L269) Returns a new point which is the max of this and another one @@ -339,7 +339,7 @@ Returns a new point which is the max of this and another one > **midPointFrom**(`that`): `Point` -Defined in: [src/Point.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L251) +Defined in: [src/Point.ts:251](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L251) Returns the point between this point and another one @@ -359,7 +359,7 @@ Returns the point between this point and another one > **min**(`that`): `Point` -Defined in: [src/Point.ts:260](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L260) +Defined in: [src/Point.ts:260](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L260) Returns a new point which is the min of this and another one @@ -379,7 +379,7 @@ Returns a new point which is the min of this and another one > **multiply**(`that`): `Point` -Defined in: [src/Point.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L120) +Defined in: [src/Point.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L120) Multiplies this point by another value and returns a new one @@ -399,7 +399,7 @@ Multiplies this point by another value and returns a new one > **rotate**(`radians`, `origin`): `Point` -Defined in: [src/Point.ts:347](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L347) +Defined in: [src/Point.ts:347](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L347) Rotates `point` around `origin` with `radians` @@ -429,7 +429,7 @@ The new rotated point > **scalarAdd**(`scalar`): `Point` -Defined in: [src/Point.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L57) +Defined in: [src/Point.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L57) Adds value to this point and returns a new one @@ -451,7 +451,7 @@ new Point with added value > **scalarAddEquals**(`scalar`): `Point` -Defined in: [src/Point.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L67) +Defined in: [src/Point.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L67) Adds value to this point @@ -477,7 +477,7 @@ thisArg > **scalarDivide**(`scalar`): `Point` -Defined in: [src/Point.ts:159](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L159) +Defined in: [src/Point.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L159) Divides this point by a value and returns a new one @@ -497,7 +497,7 @@ Divides this point by a value and returns a new one > **scalarDivideEquals**(`scalar`): `Point` -Defined in: [src/Point.ts:169](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L169) +Defined in: [src/Point.ts:169](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L169) Divides this point by a value @@ -523,7 +523,7 @@ thisArg > **scalarMultiply**(`scalar`): `Point` -Defined in: [src/Point.ts:129](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L129) +Defined in: [src/Point.ts:129](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L129) Multiplies this point by a value and returns a new one @@ -543,7 +543,7 @@ Multiplies this point by a value and returns a new one > **scalarMultiplyEquals**(`scalar`): `Point` -Defined in: [src/Point.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L139) +Defined in: [src/Point.ts:139](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L139) Multiplies this point by a value @@ -569,7 +569,7 @@ thisArg > **scalarSubtract**(`scalar`): `Point` -Defined in: [src/Point.ts:99](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L99) +Defined in: [src/Point.ts:99](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L99) Subtracts value from this point and returns a new one @@ -589,7 +589,7 @@ Subtracts value from this point and returns a new one > **scalarSubtractEquals**(`scalar`): `Point` -Defined in: [src/Point.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L109) +Defined in: [src/Point.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L109) Subtracts value from this point @@ -615,7 +615,7 @@ thisArg > **setFromPoint**(`that`): `Point` -Defined in: [src/Point.ts:314](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L314) +Defined in: [src/Point.ts:314](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L314) Sets x/y of this point from another point @@ -635,7 +635,7 @@ Sets x/y of this point from another point > **setX**(`x`): `Point` -Defined in: [src/Point.ts:296](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L296) +Defined in: [src/Point.ts:296](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L296) Sets x of this point @@ -655,7 +655,7 @@ Sets x of this point > **setXY**(`x`, `y`): `Point` -Defined in: [src/Point.ts:286](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L286) +Defined in: [src/Point.ts:286](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L286) Sets x/y of this point @@ -679,7 +679,7 @@ Sets x/y of this point > **setY**(`y`): `Point` -Defined in: [src/Point.ts:305](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L305) +Defined in: [src/Point.ts:305](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L305) Sets y of this point @@ -699,7 +699,7 @@ Sets y of this point > **subtract**(`that`): `Point` -Defined in: [src/Point.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L78) +Defined in: [src/Point.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L78) Subtracts another point from this point and returns a new one @@ -721,7 +721,7 @@ new Point object with subtracted values > **subtractEquals**(`that`): `Point` -Defined in: [src/Point.ts:88](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L88) +Defined in: [src/Point.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L88) Subtracts another point from this point @@ -747,7 +747,7 @@ thisArg > **swap**(`that`): `void` -Defined in: [src/Point.ts:324](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L324) +Defined in: [src/Point.ts:324](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L324) Swaps x/y of this point and another point @@ -767,7 +767,7 @@ Swaps x/y of this point and another point > **toString**(): `string` -Defined in: [src/Point.ts:277](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L277) +Defined in: [src/Point.ts:277](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L277) Returns string representation of this point @@ -781,7 +781,7 @@ Returns string representation of this point > **transform**(`t`, `ignoreOffset?`): `Point` -Defined in: [src/Point.ts:366](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L366) +Defined in: [src/Point.ts:366](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L366) Apply transform t to point p diff --git a/src/content/docs/api/classes/Polygon.md b/src/content/docs/api/classes/Polygon.md index 440ea793..34e9e03e 100644 --- a/src/content/docs/api/classes/Polygon.md +++ b/src/content/docs/api/classes/Polygon.md @@ -5,7 +5,7 @@ prev: false title: "Polygon" --- -Defined in: [src/shapes/Polygon.ts:4](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polygon.ts#L4) +Defined in: [src/shapes/Polygon.ts:4](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polygon.ts#L4) Exported so we can tweak default values @@ -19,7 +19,7 @@ Exported so we can tweak default values > **new Polygon**(`points`, `options?`): `Polygon` -Defined in: [src/shapes/Polyline.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L118) +Defined in: [src/shapes/Polyline.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L118) Constructor @@ -70,7 +70,7 @@ var poly = new Polyline([ > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -88,7 +88,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -104,7 +104,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -126,7 +126,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -151,7 +151,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -170,7 +170,7 @@ You can calculate them without updating with [()](/api/classes/polygon/#calcacoo > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -190,7 +190,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -205,7 +205,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -225,7 +225,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -243,7 +243,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -263,7 +263,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -287,7 +287,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -309,7 +309,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -328,7 +328,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -345,7 +345,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -360,7 +360,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -375,7 +375,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -395,7 +395,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -419,7 +419,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -439,7 +439,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -463,7 +463,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -493,7 +493,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -514,7 +514,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -528,7 +528,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **exactBoundingBox**: `boolean` -Defined in: [src/shapes/Polyline.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L61) +Defined in: [src/shapes/Polyline.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L61) WARNING: Feature in progress Calculate the exact bounding box taking in account strokeWidth on acute angles @@ -555,7 +555,7 @@ false > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -573,7 +573,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -594,7 +594,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -616,7 +616,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -636,7 +636,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -656,7 +656,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -670,7 +670,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -684,7 +684,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -704,7 +704,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -718,7 +718,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -738,7 +738,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -752,7 +752,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -774,7 +774,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -789,7 +789,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -811,7 +811,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -825,7 +825,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -839,7 +839,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -853,7 +853,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -867,7 +867,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -881,7 +881,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -895,7 +895,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -909,7 +909,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -923,7 +923,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -937,7 +937,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -957,7 +957,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -977,11 +977,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1001,7 +1001,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1027,7 +1027,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1044,7 +1044,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1064,7 +1064,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1080,7 +1080,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1096,7 +1096,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1110,7 +1110,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1130,7 +1130,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1144,7 +1144,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1159,7 +1159,7 @@ Used to keep the original parent ref when the object has been added to an Active > **pathOffset**: [`Point`](/api/classes/point/) -Defined in: [src/shapes/Polyline.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L91) +Defined in: [src/shapes/Polyline.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L91) #### Inherited from @@ -1171,7 +1171,7 @@ Defined in: [src/shapes/Polyline.ts:91](https://github.com/fabricjs/fabric.js/bl > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1185,7 +1185,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **points**: [`XY`](/api/interfaces/xy/)[] -Defined in: [src/shapes/Polyline.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L50) +Defined in: [src/shapes/Polyline.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L50) Points array @@ -1199,7 +1199,7 @@ Points array > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1219,7 +1219,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1239,7 +1239,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1254,7 +1254,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1273,7 +1273,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1293,7 +1293,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1313,7 +1313,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1333,7 +1333,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1347,7 +1347,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1362,7 +1362,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1383,7 +1383,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1403,7 +1403,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1423,7 +1423,7 @@ Line offset of an object's stroke > **strokeDiff**: [`Point`](/api/classes/point/) -Defined in: [src/shapes/Polyline.ts:97](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L97) +Defined in: [src/shapes/Polyline.ts:97](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L97) #### Inherited from @@ -1435,7 +1435,7 @@ Defined in: [src/shapes/Polyline.ts:97](https://github.com/fabricjs/fabric.js/bl > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1455,7 +1455,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1469,7 +1469,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1489,7 +1489,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeOffset**: [`Point`](/api/classes/point/) -Defined in: [src/shapes/Polyline.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L93) +Defined in: [src/shapes/Polyline.ts:93](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L93) #### Inherited from @@ -1501,7 +1501,7 @@ Defined in: [src/shapes/Polyline.ts:93](https://github.com/fabricjs/fabric.js/bl > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1534,7 +1534,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1554,7 +1554,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1576,7 +1576,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1596,7 +1596,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1616,7 +1616,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1630,7 +1630,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1644,7 +1644,7 @@ Object width > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Polyline.ts:387](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L387) +Defined in: [src/shapes/Polyline.ts:387](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L387) List of attribute names to account for when parsing SVG element (used by [Polyline.fromElement](/api/classes/polyline/#fromelement)) @see: http://www.w3.org/TR/SVG/shapes.html#PolylineElement @@ -1659,7 +1659,7 @@ List of attribute names to account for when parsing SVG element (used by [Polyli > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Polyline.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L95) +Defined in: [src/shapes/Polyline.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L95) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1676,7 +1676,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1690,7 +1690,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1705,7 +1705,7 @@ instance.toObject() gets called > `static` **layoutProperties**: keyof [`Polyline`](/api/classes/polyline/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedPolylineProps`](/api/interfaces/serializedpolylineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/shapes/Polyline.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L80) +Defined in: [src/shapes/Polyline.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L80) A list of properties that if changed trigger a recalculation of dimensions @@ -1723,7 +1723,7 @@ check if you really need to recalculate for all cases > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<[`Polyline`](/api/classes/polyline/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedPolylineProps`](/api/interfaces/serializedpolylineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `polylineDefaultValues` -Defined in: [src/shapes/Polygon.ts:5](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polygon.ts#L5) +Defined in: [src/shapes/Polygon.ts:5](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polygon.ts#L5) #### Overrides @@ -1735,7 +1735,7 @@ Defined in: [src/shapes/Polygon.ts:5](https://github.com/fabricjs/fabric.js/blob > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1751,7 +1751,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Polygon'` -Defined in: [src/shapes/Polygon.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polygon.ts#L7) +Defined in: [src/shapes/Polygon.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polygon.ts#L7) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1774,7 +1774,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1797,7 +1797,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1819,7 +1819,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -1851,7 +1851,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_getNonTransformedDimensions**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Polyline.ts:236](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L236) +Defined in: [src/shapes/Polyline.ts:236](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L236) stroke is taken in account in size @@ -1869,7 +1869,7 @@ stroke is taken in account in size > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -1899,7 +1899,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -1917,7 +1917,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -1954,7 +1954,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -1976,7 +1976,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -2002,7 +2002,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -2028,7 +2028,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2055,7 +2055,7 @@ Rendering canvas context > **\_toSVG**(): `string`[] -Defined in: [src/shapes/Polyline.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L326) +Defined in: [src/shapes/Polyline.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L326) Returns svg representation of an instance @@ -2076,7 +2076,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2098,7 +2098,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2145,7 +2145,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2164,7 +2164,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2185,7 +2185,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2206,7 +2206,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2236,7 +2236,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2262,7 +2262,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2298,7 +2298,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Polygon`\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2324,7 +2324,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2361,7 +2361,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Polyline.ts:377](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L377) +Defined in: [src/shapes/Polyline.ts:377](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L377) Returns complexity of an instance @@ -2381,7 +2381,7 @@ complexity of this instance > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2409,7 +2409,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2428,7 +2428,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2468,7 +2468,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2498,7 +2498,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2532,7 +2532,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2569,7 +2569,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2603,7 +2603,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2641,7 +2641,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2676,7 +2676,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2708,7 +2708,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2746,7 +2746,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2773,7 +2773,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2801,7 +2801,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -2817,7 +2817,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -2835,7 +2835,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -2856,7 +2856,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -2872,7 +2872,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -2890,7 +2890,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -2908,7 +2908,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -2926,7 +2926,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -2944,7 +2944,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/polygon/#getpositionbyorigin) @@ -2976,7 +2976,7 @@ use [getPositionByOrigin](/api/classes/polygon/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/polygon/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -3014,7 +3014,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3032,7 +3032,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3051,7 +3051,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/polyg > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3069,7 +3069,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3088,7 +3088,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/polyg > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3112,7 +3112,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3136,7 +3136,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3160,7 +3160,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3184,7 +3184,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3214,7 +3214,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3246,7 +3246,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3264,7 +3264,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3284,7 +3284,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3302,7 +3302,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3320,7 +3320,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3338,7 +3338,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3356,7 +3356,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3384,7 +3384,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3413,7 +3413,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3442,7 +3442,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3470,7 +3470,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3498,7 +3498,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3528,7 +3528,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3556,7 +3556,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3584,7 +3584,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3613,7 +3613,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3638,7 +3638,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3670,7 +3670,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3688,7 +3688,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3709,7 +3709,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3737,7 +3737,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3757,7 +3757,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -3793,7 +3793,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -3819,7 +3819,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -3855,7 +3855,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -3891,7 +3891,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -3915,7 +3915,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -3935,7 +3935,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -3981,7 +3981,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4015,7 +4015,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4061,7 +4061,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4093,7 +4093,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4126,7 +4126,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4153,7 +4153,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4184,7 +4184,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4210,7 +4210,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4236,7 +4236,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4262,7 +4262,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4288,7 +4288,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4315,7 +4315,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4341,7 +4341,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4367,7 +4367,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4393,7 +4393,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4419,7 +4419,7 @@ New width value > **set**(`key`, `value?`): `Polygon` -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4451,7 +4451,7 @@ Property value (if function, the value is passed into it and its return value is > **setBoundingBox**(`adjustPosition?`): `void` -Defined in: [src/shapes/Polyline.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L214) +Defined in: [src/shapes/Polyline.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L214) #### Parameters @@ -4473,7 +4473,7 @@ Defined in: [src/shapes/Polyline.ts:214](https://github.com/fabricjs/fabric.js/b > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4500,7 +4500,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4538,7 +4538,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4557,7 +4557,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setDimensions**(): `void` -Defined in: [src/shapes/Polyline.ts:210](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L210) +Defined in: [src/shapes/Polyline.ts:210](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L210) #### Returns @@ -4573,7 +4573,7 @@ Defined in: [src/shapes/Polyline.ts:210](https://github.com/fabricjs/fabric.js/b > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4594,7 +4594,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4632,7 +4632,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4657,7 +4657,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/polygon > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/polygon/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4695,7 +4695,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4720,7 +4720,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/polyg > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4744,7 +4744,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4790,7 +4790,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4814,7 +4814,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -4837,7 +4837,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -4864,7 +4864,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -4896,7 +4896,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -4918,7 +4918,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -4946,7 +4946,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -4978,7 +4978,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -5006,7 +5006,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -5034,7 +5034,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Polygon` -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -5060,7 +5060,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5080,7 +5080,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & [`SerializedPolylineProps`](/api/interfaces/serializedpolylineprops/) -Defined in: [src/shapes/Polyline.ts:311](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L311) +Defined in: [src/shapes/Polyline.ts:311](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L311) Returns object representation of an instance @@ -5118,7 +5118,7 @@ Object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -5136,7 +5136,7 @@ Returns a string representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5168,7 +5168,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5194,7 +5194,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5216,7 +5216,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5254,7 +5254,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5304,7 +5304,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5342,7 +5342,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5365,7 +5365,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5397,7 +5397,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5421,7 +5421,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<[`Polyline`](/api/classes/polyline/)\<\{ `signal?`: `AbortSignal`; \}, [`SerializedPolylineProps`](/api/interfaces/serializedpolylineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Polyline.ts:394](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L394) +Defined in: [src/shapes/Polyline.ts:394](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L394) Returns Polyline instance from an SVG element @@ -5457,7 +5457,7 @@ Options object > `static` **fromObject**\<`T`\>(`object`): `Promise`\<[`Polyline`](/api/classes/polyline/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedPolylineProps`](/api/interfaces/serializedpolylineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Polyline.ts:420](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L420) +Defined in: [src/shapes/Polyline.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L420) Returns Polyline instance from an object representation @@ -5489,7 +5489,7 @@ Object to create an instance from > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Polyline.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L69) +Defined in: [src/shapes/Polyline.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L69) #### Returns diff --git a/src/content/docs/api/classes/Polyline.md b/src/content/docs/api/classes/Polyline.md index f37a5ed4..9e64f951 100644 --- a/src/content/docs/api/classes/Polyline.md +++ b/src/content/docs/api/classes/Polyline.md @@ -5,7 +5,7 @@ prev: false title: "Polyline" --- -Defined in: [src/shapes/Polyline.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L41) +Defined in: [src/shapes/Polyline.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L41) Exported so we can tweak default values @@ -37,7 +37,7 @@ Exported so we can tweak default values > **new Polyline**\<`Props`, `SProps`, `EventSpec`\>(`points`, `options?`): `Polyline`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Polyline.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L118) +Defined in: [src/shapes/Polyline.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L118) Constructor @@ -88,7 +88,7 @@ var poly = new Polyline([ > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -106,7 +106,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -122,7 +122,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -144,7 +144,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -169,7 +169,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -188,7 +188,7 @@ You can calculate them without updating with [()](/api/classes/polyline/#calcaco > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -208,7 +208,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -223,7 +223,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -243,7 +243,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -261,7 +261,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -281,7 +281,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -305,7 +305,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -327,7 +327,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -346,7 +346,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -363,7 +363,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -378,7 +378,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -393,7 +393,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -413,7 +413,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -437,7 +437,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -457,7 +457,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -481,7 +481,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -511,7 +511,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -532,7 +532,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -546,7 +546,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **exactBoundingBox**: `boolean` -Defined in: [src/shapes/Polyline.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L61) +Defined in: [src/shapes/Polyline.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L61) WARNING: Feature in progress Calculate the exact bounding box taking in account strokeWidth on acute angles @@ -569,7 +569,7 @@ false > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -587,7 +587,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -608,7 +608,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -630,7 +630,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -650,7 +650,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -670,7 +670,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -684,7 +684,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -698,7 +698,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -718,7 +718,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -732,7 +732,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -752,7 +752,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -766,7 +766,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -788,7 +788,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -803,7 +803,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -825,7 +825,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -839,7 +839,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -853,7 +853,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -867,7 +867,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -881,7 +881,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -895,7 +895,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -909,7 +909,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -923,7 +923,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -937,7 +937,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -951,7 +951,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -971,7 +971,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -991,11 +991,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1015,7 +1015,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1041,7 +1041,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1058,7 +1058,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1078,7 +1078,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1094,7 +1094,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1110,7 +1110,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1124,7 +1124,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1144,7 +1144,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1158,7 +1158,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1173,7 +1173,7 @@ Used to keep the original parent ref when the object has been added to an Active > **pathOffset**: [`Point`](/api/classes/point/) -Defined in: [src/shapes/Polyline.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L91) +Defined in: [src/shapes/Polyline.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L91) *** @@ -1181,7 +1181,7 @@ Defined in: [src/shapes/Polyline.ts:91](https://github.com/fabricjs/fabric.js/bl > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1195,7 +1195,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **points**: [`XY`](/api/interfaces/xy/)[] -Defined in: [src/shapes/Polyline.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L50) +Defined in: [src/shapes/Polyline.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L50) Points array @@ -1205,7 +1205,7 @@ Points array > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1225,7 +1225,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1245,7 +1245,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1260,7 +1260,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1279,7 +1279,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1299,7 +1299,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1319,7 +1319,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1339,7 +1339,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1353,7 +1353,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1368,7 +1368,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1389,7 +1389,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1409,7 +1409,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1429,7 +1429,7 @@ Line offset of an object's stroke > **strokeDiff**: [`Point`](/api/classes/point/) -Defined in: [src/shapes/Polyline.ts:97](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L97) +Defined in: [src/shapes/Polyline.ts:97](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L97) *** @@ -1437,7 +1437,7 @@ Defined in: [src/shapes/Polyline.ts:97](https://github.com/fabricjs/fabric.js/bl > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1457,7 +1457,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1471,7 +1471,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1491,7 +1491,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeOffset**: [`Point`](/api/classes/point/) -Defined in: [src/shapes/Polyline.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L93) +Defined in: [src/shapes/Polyline.ts:93](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L93) *** @@ -1499,7 +1499,7 @@ Defined in: [src/shapes/Polyline.ts:93](https://github.com/fabricjs/fabric.js/bl > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1532,7 +1532,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1552,7 +1552,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1574,7 +1574,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1594,7 +1594,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1614,7 +1614,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1628,7 +1628,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1642,7 +1642,7 @@ Object width > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Polyline.ts:387](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L387) +Defined in: [src/shapes/Polyline.ts:387](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L387) List of attribute names to account for when parsing SVG element (used by [Polyline.fromElement](/api/classes/polyline/#fromelement)) @see: http://www.w3.org/TR/SVG/shapes.html#PolylineElement @@ -1653,7 +1653,7 @@ List of attribute names to account for when parsing SVG element (used by [Polyli > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Polyline.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L95) +Defined in: [src/shapes/Polyline.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L95) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1670,7 +1670,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1684,7 +1684,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1699,7 +1699,7 @@ instance.toObject() gets called > `static` **layoutProperties**: keyof `Polyline`\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedPolylineProps`](/api/interfaces/serializedpolylineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/shapes/Polyline.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L80) +Defined in: [src/shapes/Polyline.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L80) A list of properties that if changed trigger a recalculation of dimensions @@ -1713,7 +1713,7 @@ check if you really need to recalculate for all cases > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`Polyline`\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedPolylineProps`](/api/interfaces/serializedpolylineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `polylineDefaultValues` -Defined in: [src/shapes/Polyline.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L65) +Defined in: [src/shapes/Polyline.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L65) #### Overrides @@ -1725,7 +1725,7 @@ Defined in: [src/shapes/Polyline.ts:65](https://github.com/fabricjs/fabric.js/bl > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1741,7 +1741,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Polyline'` -Defined in: [src/shapes/Polyline.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L67) +Defined in: [src/shapes/Polyline.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L67) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1764,7 +1764,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1787,7 +1787,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1809,7 +1809,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -1841,7 +1841,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_getNonTransformedDimensions**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Polyline.ts:236](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L236) +Defined in: [src/shapes/Polyline.ts:236](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L236) stroke is taken in account in size @@ -1859,7 +1859,7 @@ stroke is taken in account in size > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -1889,7 +1889,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -1907,7 +1907,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -1944,7 +1944,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -1966,7 +1966,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -1992,7 +1992,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -2018,7 +2018,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2045,7 +2045,7 @@ Rendering canvas context > **\_toSVG**(): `string`[] -Defined in: [src/shapes/Polyline.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L326) +Defined in: [src/shapes/Polyline.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L326) Returns svg representation of an instance @@ -2066,7 +2066,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2088,7 +2088,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2135,7 +2135,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2154,7 +2154,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2175,7 +2175,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2196,7 +2196,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2226,7 +2226,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2252,7 +2252,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2288,7 +2288,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Polyline`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2314,7 +2314,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2351,7 +2351,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Polyline.ts:377](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L377) +Defined in: [src/shapes/Polyline.ts:377](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L377) Returns complexity of an instance @@ -2371,7 +2371,7 @@ complexity of this instance > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2399,7 +2399,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2418,7 +2418,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2458,7 +2458,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2488,7 +2488,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2522,7 +2522,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2559,7 +2559,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2593,7 +2593,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2631,7 +2631,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2666,7 +2666,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2698,7 +2698,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2736,7 +2736,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2763,7 +2763,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2791,7 +2791,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -2807,7 +2807,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -2825,7 +2825,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -2846,7 +2846,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -2862,7 +2862,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -2880,7 +2880,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -2898,7 +2898,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -2916,7 +2916,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -2934,7 +2934,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/polyline/#getpositionbyorigin) @@ -2966,7 +2966,7 @@ use [getPositionByOrigin](/api/classes/polyline/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/polyline/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -3004,7 +3004,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3022,7 +3022,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3041,7 +3041,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/polyl > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3059,7 +3059,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3078,7 +3078,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/polyl > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3102,7 +3102,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3126,7 +3126,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3150,7 +3150,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3174,7 +3174,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3204,7 +3204,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3236,7 +3236,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3254,7 +3254,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3274,7 +3274,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3292,7 +3292,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3310,7 +3310,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3328,7 +3328,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3346,7 +3346,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3374,7 +3374,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3403,7 +3403,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3432,7 +3432,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3460,7 +3460,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3488,7 +3488,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3518,7 +3518,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3546,7 +3546,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3574,7 +3574,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3603,7 +3603,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3628,7 +3628,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3660,7 +3660,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3678,7 +3678,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3699,7 +3699,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3727,7 +3727,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3747,7 +3747,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -3783,7 +3783,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -3809,7 +3809,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -3845,7 +3845,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -3881,7 +3881,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -3905,7 +3905,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -3925,7 +3925,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -3971,7 +3971,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4005,7 +4005,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4051,7 +4051,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4083,7 +4083,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4116,7 +4116,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4143,7 +4143,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4174,7 +4174,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4200,7 +4200,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4226,7 +4226,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4252,7 +4252,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4278,7 +4278,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4305,7 +4305,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4331,7 +4331,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4357,7 +4357,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4383,7 +4383,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4409,7 +4409,7 @@ New width value > **set**(`key`, `value?`): `Polyline`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4441,7 +4441,7 @@ Property value (if function, the value is passed into it and its return value is > **setBoundingBox**(`adjustPosition?`): `void` -Defined in: [src/shapes/Polyline.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L214) +Defined in: [src/shapes/Polyline.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L214) #### Parameters @@ -4459,7 +4459,7 @@ Defined in: [src/shapes/Polyline.ts:214](https://github.com/fabricjs/fabric.js/b > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4486,7 +4486,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4524,7 +4524,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4543,7 +4543,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setDimensions**(): `void` -Defined in: [src/shapes/Polyline.ts:210](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L210) +Defined in: [src/shapes/Polyline.ts:210](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L210) #### Returns @@ -4555,7 +4555,7 @@ Defined in: [src/shapes/Polyline.ts:210](https://github.com/fabricjs/fabric.js/b > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4576,7 +4576,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4614,7 +4614,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4639,7 +4639,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/polylin > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/polyline/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4677,7 +4677,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4702,7 +4702,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/polyl > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4726,7 +4726,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4772,7 +4772,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4796,7 +4796,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -4819,7 +4819,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -4846,7 +4846,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -4878,7 +4878,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -4900,7 +4900,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -4928,7 +4928,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -4960,7 +4960,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -4988,7 +4988,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -5016,7 +5016,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Polyline`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -5042,7 +5042,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5062,7 +5062,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Polyline.ts:311](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L311) +Defined in: [src/shapes/Polyline.ts:311](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L311) Returns object representation of an instance @@ -5100,7 +5100,7 @@ Object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -5118,7 +5118,7 @@ Returns a string representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5150,7 +5150,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5176,7 +5176,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5198,7 +5198,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5236,7 +5236,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5286,7 +5286,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5324,7 +5324,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5347,7 +5347,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5379,7 +5379,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5403,7 +5403,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<`Polyline`\<\{ `signal?`: `AbortSignal`; \}, [`SerializedPolylineProps`](/api/interfaces/serializedpolylineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Polyline.ts:394](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L394) +Defined in: [src/shapes/Polyline.ts:394](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L394) Returns Polyline instance from an SVG element @@ -5435,7 +5435,7 @@ Options object > `static` **fromObject**\<`T`\>(`object`): `Promise`\<`Polyline`\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedPolylineProps`](/api/interfaces/serializedpolylineprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Polyline.ts:420](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L420) +Defined in: [src/shapes/Polyline.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L420) Returns Polyline instance from an object representation @@ -5467,7 +5467,7 @@ Object to create an instance from > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Polyline.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L69) +Defined in: [src/shapes/Polyline.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L69) #### Returns diff --git a/src/content/docs/api/classes/Rect.md b/src/content/docs/api/classes/Rect.md index 85512610..59ef3375 100644 --- a/src/content/docs/api/classes/Rect.md +++ b/src/content/docs/api/classes/Rect.md @@ -5,7 +5,7 @@ prev: false title: "Rect" --- -Defined in: [src/shapes/Rect.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L29) +Defined in: [src/shapes/Rect.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L29) Exported so we can tweak default values @@ -37,7 +37,7 @@ Exported so we can tweak default values > **new Rect**\<`Props`, `SProps`, `EventSpec`\>(`options?`): `Rect`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Rect.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L66) +Defined in: [src/shapes/Rect.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L66) Constructor @@ -63,7 +63,7 @@ Options object > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -81,7 +81,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -97,7 +97,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -119,7 +119,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -148,7 +148,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -167,7 +167,7 @@ You can calculate them without updating with [()](/api/classes/rect/#calcacoords > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -191,7 +191,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -210,7 +210,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -234,7 +234,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -256,7 +256,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -280,7 +280,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -308,7 +308,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -334,7 +334,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -357,7 +357,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -378,7 +378,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -393,7 +393,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -408,7 +408,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -432,7 +432,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -460,7 +460,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -484,7 +484,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -512,7 +512,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -546,7 +546,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -567,7 +567,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -585,7 +585,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -607,7 +607,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -632,7 +632,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -658,7 +658,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -682,7 +682,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -706,7 +706,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -724,7 +724,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -742,7 +742,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -766,7 +766,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -784,7 +784,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -808,7 +808,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -826,7 +826,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -852,7 +852,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -867,7 +867,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -893,7 +893,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -911,7 +911,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -929,7 +929,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -947,7 +947,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -965,7 +965,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -983,7 +983,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -1001,7 +1001,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -1019,7 +1019,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -1037,7 +1037,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -1051,7 +1051,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -1075,7 +1075,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -1099,11 +1099,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1127,7 +1127,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1157,7 +1157,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1174,7 +1174,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1198,7 +1198,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1218,7 +1218,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1238,7 +1238,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1252,7 +1252,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1276,7 +1276,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1294,7 +1294,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1309,7 +1309,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1327,7 +1327,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **rx**: `number` -Defined in: [src/shapes/Rect.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L41) +Defined in: [src/shapes/Rect.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L41) Horizontal border radius @@ -1341,7 +1341,7 @@ Horizontal border radius > **ry**: `number` -Defined in: [src/shapes/Rect.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L47) +Defined in: [src/shapes/Rect.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L47) Vertical border radius @@ -1355,7 +1355,7 @@ Vertical border radius > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1379,7 +1379,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1403,7 +1403,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1422,7 +1422,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1445,7 +1445,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1469,7 +1469,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1493,7 +1493,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1517,7 +1517,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1535,7 +1535,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1554,7 +1554,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1579,7 +1579,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1603,7 +1603,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1627,7 +1627,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1651,7 +1651,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1669,7 +1669,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1693,7 +1693,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1730,7 +1730,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1754,7 +1754,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1780,7 +1780,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1804,7 +1804,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1828,7 +1828,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1846,7 +1846,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1864,7 +1864,7 @@ Object width > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Rect.ts:175](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L175) +Defined in: [src/shapes/Rect.ts:175](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L175) List of attribute names to account for when parsing SVG element (used by `Rect.fromElement`) @see: http://www.w3.org/TR/SVG/shapes.html#RectElement @@ -1875,7 +1875,7 @@ List of attribute names to account for when parsing SVG element (used by `Rect.f > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Rect.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L51) +Defined in: [src/shapes/Rect.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L51) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1892,7 +1892,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1906,7 +1906,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1921,7 +1921,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`Rect`\<`Partial`\<[`RectProps`](/api/interfaces/rectprops/)\>, [`SerializedRectProps`](/api/interfaces/serializedrectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `rectDefaultValues` -Defined in: [src/shapes/Rect.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L53) +Defined in: [src/shapes/Rect.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L53) #### Overrides @@ -1933,7 +1933,7 @@ Defined in: [src/shapes/Rect.ts:53](https://github.com/fabricjs/fabric.js/blob/2 > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1949,7 +1949,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Rect'` -Defined in: [src/shapes/Rect.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L49) +Defined in: [src/shapes/Rect.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L49) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1972,7 +1972,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1995,7 +1995,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -2017,7 +2017,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -2049,7 +2049,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -2079,7 +2079,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -2097,7 +2097,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -2134,7 +2134,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -2156,7 +2156,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -2182,7 +2182,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -2208,7 +2208,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2235,7 +2235,7 @@ Rendering canvas context > **\_toSVG**(): `string`[] -Defined in: [src/shapes/Rect.ts:160](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L160) +Defined in: [src/shapes/Rect.ts:160](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L160) Returns svg representation of an instance @@ -2256,7 +2256,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2278,7 +2278,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2325,7 +2325,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2344,7 +2344,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2365,7 +2365,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2386,7 +2386,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2416,7 +2416,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2442,7 +2442,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2478,7 +2478,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Rect`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2504,7 +2504,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2541,7 +2541,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1429) +Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1429) Returns complexity of an instance @@ -2561,7 +2561,7 @@ complexity of this instance (is 1 unless subclassed) > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2589,7 +2589,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2608,7 +2608,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2648,7 +2648,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2678,7 +2678,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2712,7 +2712,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2749,7 +2749,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2783,7 +2783,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2821,7 +2821,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2856,7 +2856,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2888,7 +2888,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2926,7 +2926,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2953,7 +2953,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2981,7 +2981,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -2997,7 +2997,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -3015,7 +3015,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -3036,7 +3036,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -3052,7 +3052,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -3070,7 +3070,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -3088,7 +3088,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -3106,7 +3106,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -3124,7 +3124,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/rect/#getpositionbyorigin) @@ -3156,7 +3156,7 @@ use [getPositionByOrigin](/api/classes/rect/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/rect/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -3194,7 +3194,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3212,7 +3212,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3231,7 +3231,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/rect/ > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3249,7 +3249,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3268,7 +3268,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/rect/ > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3292,7 +3292,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3316,7 +3316,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3340,7 +3340,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3364,7 +3364,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3394,7 +3394,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3426,7 +3426,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3444,7 +3444,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3464,7 +3464,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3482,7 +3482,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3500,7 +3500,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3518,7 +3518,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3536,7 +3536,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3564,7 +3564,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3593,7 +3593,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3622,7 +3622,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3650,7 +3650,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3678,7 +3678,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3708,7 +3708,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3736,7 +3736,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3764,7 +3764,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3793,7 +3793,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3818,7 +3818,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3850,7 +3850,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3868,7 +3868,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3889,7 +3889,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3917,7 +3917,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3937,7 +3937,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -3973,7 +3973,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -3999,7 +3999,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -4035,7 +4035,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -4071,7 +4071,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -4095,7 +4095,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -4115,7 +4115,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -4161,7 +4161,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4195,7 +4195,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4241,7 +4241,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4273,7 +4273,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4306,7 +4306,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4333,7 +4333,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4364,7 +4364,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4390,7 +4390,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4416,7 +4416,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4442,7 +4442,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4468,7 +4468,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4495,7 +4495,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4521,7 +4521,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4547,7 +4547,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4573,7 +4573,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4599,7 +4599,7 @@ New width value > **set**(`key`, `value?`): `Rect`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4631,7 +4631,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4658,7 +4658,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4696,7 +4696,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4715,7 +4715,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4736,7 +4736,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4774,7 +4774,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4799,7 +4799,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/rect/#s > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/rect/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4837,7 +4837,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4862,7 +4862,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/rect/ > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4886,7 +4886,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4932,7 +4932,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4956,7 +4956,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -4979,7 +4979,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -5006,7 +5006,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -5038,7 +5038,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -5060,7 +5060,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -5088,7 +5088,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -5120,7 +5120,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -5148,7 +5148,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -5176,7 +5176,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Rect`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -5202,7 +5202,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5222,7 +5222,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Rect.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L148) +Defined in: [src/shapes/Rect.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L148) Returns object representation of an instance @@ -5260,7 +5260,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -5278,7 +5278,7 @@ Returns a string representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5310,7 +5310,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5336,7 +5336,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5358,7 +5358,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5396,7 +5396,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5446,7 +5446,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5484,7 +5484,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5507,7 +5507,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5539,7 +5539,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5563,7 +5563,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<`Rect`\<\{ `height`: `any`; `left`: `any`; `signal?`: `AbortSignal`; `top`: `any`; `visible`: `boolean`; `width`: `any`; \}, [`SerializedRectProps`](/api/interfaces/serializedrectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Rect.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L192) +Defined in: [src/shapes/Rect.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L192) Returns [Rect](/api/classes/rect/) instance from an SVG element @@ -5595,7 +5595,7 @@ Options object > `static` **fromObject**\<`T`\>(`object`, `options?`): `Promise`\<[`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1931) +Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1931) #### Type Parameters @@ -5627,7 +5627,7 @@ Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabri > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Rect.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L55) +Defined in: [src/shapes/Rect.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L55) #### Returns diff --git a/src/content/docs/api/classes/Shadow.md b/src/content/docs/api/classes/Shadow.md index 0cc17849..9dc7d5ad 100644 --- a/src/content/docs/api/classes/Shadow.md +++ b/src/content/docs/api/classes/Shadow.md @@ -5,7 +5,7 @@ prev: false title: "Shadow" --- -Defined in: [src/Shadow.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L63) +Defined in: [src/Shadow.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L63) ## Constructors @@ -13,7 +13,7 @@ Defined in: [src/Shadow.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4 > **new Shadow**(`options?`): `Shadow` -Defined in: [src/Shadow.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L118) +Defined in: [src/Shadow.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L118) #### Parameters @@ -35,7 +35,7 @@ Options object with any of color, blur, offsetX, offsetY properties or string (e > **new Shadow**(`svgAttribute`): `Shadow` -Defined in: [src/Shadow.ts:119](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L119) +Defined in: [src/Shadow.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L119) #### Parameters @@ -53,7 +53,7 @@ Defined in: [src/Shadow.ts:119](https://github.com/fabricjs/fabric.js/blob/22fda > **affectStroke**: `boolean` -Defined in: [src/Shadow.ts:92](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L92) +Defined in: [src/Shadow.ts:92](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L92) Whether the shadow should affect stroke operations @@ -63,7 +63,7 @@ Whether the shadow should affect stroke operations > **blur**: `number` -Defined in: [src/Shadow.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L74) +Defined in: [src/Shadow.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L74) Shadow blur @@ -73,7 +73,7 @@ Shadow blur > **color**: `string` -Defined in: [src/Shadow.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L68) +Defined in: [src/Shadow.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L68) Shadow color @@ -83,7 +83,7 @@ Shadow color > **id**: `string` \| `number` -Defined in: [src/Shadow.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L108) +Defined in: [src/Shadow.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L108) *** @@ -91,7 +91,7 @@ Defined in: [src/Shadow.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda > **includeDefaultValues**: `boolean` -Defined in: [src/Shadow.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L98) +Defined in: [src/Shadow.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L98) Indicates whether toObject should include default values @@ -101,7 +101,7 @@ Indicates whether toObject should include default values > **nonScaling**: `boolean` -Defined in: [src/Shadow.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L106) +Defined in: [src/Shadow.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L106) When `false`, the shadow will scale with the object. When `true`, the shadow's offsetX, offsetY, and blur will not be affected by the object's scale. @@ -113,7 +113,7 @@ default to false > **offsetX**: `number` -Defined in: [src/Shadow.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L80) +Defined in: [src/Shadow.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L80) Shadow horizontal offset @@ -123,7 +123,7 @@ Shadow horizontal offset > **offsetY**: `number` -Defined in: [src/Shadow.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L86) +Defined in: [src/Shadow.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L86) Shadow vertical offset @@ -133,7 +133,7 @@ Shadow vertical offset > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`Shadow`\>\> = `shadowDefaultValues` -Defined in: [src/Shadow.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L110) +Defined in: [src/Shadow.ts:110](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L110) *** @@ -141,7 +141,7 @@ Defined in: [src/Shadow.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda > `static` **type**: `string` = `'shadow'` -Defined in: [src/Shadow.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L112) +Defined in: [src/Shadow.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L112) ## Methods @@ -149,7 +149,7 @@ Defined in: [src/Shadow.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda > **toObject**(): `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/Shadow.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L216) +Defined in: [src/Shadow.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L216) Returns object representation of a shadow @@ -165,7 +165,7 @@ Object representation of a shadow instance > **toString**(): `string` -Defined in: [src/Shadow.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L151) +Defined in: [src/Shadow.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L151) Returns a string representation of an instance @@ -185,7 +185,7 @@ http://www.w3.org/TR/css-text-decor-3/#text-shadow > **toSVG**(`object`): `string` -Defined in: [src/Shadow.ts:160](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L160) +Defined in: [src/Shadow.ts:160](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L160) Returns SVG representation of a shadow @@ -207,7 +207,7 @@ SVG representation of a shadow > `static` **fromObject**(`options`): `Promise`\<`Shadow`\> -Defined in: [src/Shadow.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L232) +Defined in: [src/Shadow.ts:232](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L232) #### Parameters @@ -225,7 +225,7 @@ Defined in: [src/Shadow.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda > `static` **parseShadow**(`value`): `object` -Defined in: [src/Shadow.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L131) +Defined in: [src/Shadow.ts:131](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L131) #### Parameters diff --git a/src/content/docs/api/classes/SprayBrush.md b/src/content/docs/api/classes/SprayBrush.md index 75ea6145..e534173d 100644 --- a/src/content/docs/api/classes/SprayBrush.md +++ b/src/content/docs/api/classes/SprayBrush.md @@ -5,7 +5,7 @@ prev: false title: "SprayBrush" --- -Defined in: [src/brushes/SprayBrush.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L31) +Defined in: [src/brushes/SprayBrush.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L31) ## See @@ -21,7 +21,7 @@ Defined in: [src/brushes/SprayBrush.ts:31](https://github.com/fabricjs/fabric.js > **new SprayBrush**(`canvas`): `SprayBrush` -Defined in: [src/brushes/SprayBrush.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L77) +Defined in: [src/brushes/SprayBrush.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L77) Constructor @@ -47,7 +47,7 @@ Instance of a spray brush > **canvas**: [`Canvas`](/api/classes/canvas/) -Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L66) +Defined in: [src/brushes/BaseBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L66) #### Todo @@ -63,7 +63,7 @@ add type > **color**: `string` = `'rgb(0, 0, 0)'` -Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L15) +Defined in: [src/brushes/BaseBrush.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L15) Color of a brush @@ -77,7 +77,7 @@ Color of a brush > **density**: `number` = `20` -Defined in: [src/brushes/SprayBrush.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L42) +Defined in: [src/brushes/SprayBrush.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L42) Density of a spray (number of dots per chunk) @@ -87,7 +87,7 @@ Density of a spray (number of dots per chunk) > **dotWidth**: `number` = `1` -Defined in: [src/brushes/SprayBrush.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L48) +Defined in: [src/brushes/SprayBrush.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L48) Width of spray dots @@ -97,7 +97,7 @@ Width of spray dots > **dotWidthVariance**: `number` = `1` -Defined in: [src/brushes/SprayBrush.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L54) +Defined in: [src/brushes/SprayBrush.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L54) Width variance of spray dots @@ -107,7 +107,7 @@ Width variance of spray dots > **limitedToCanvasSize**: `boolean` = `false` -Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L61) +Defined in: [src/brushes/BaseBrush.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L61) When `true`, the free drawing is limited to the whiteboard size. Default to false. @@ -127,7 +127,7 @@ false > **optimizeOverlapping**: `boolean` = `true` -Defined in: [src/brushes/SprayBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L66) +Defined in: [src/brushes/SprayBrush.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L66) Whether overlapping dots (rectangles) should be removed (for performance reasons) @@ -137,7 +137,7 @@ Whether overlapping dots (rectangles) should be removed (for performance reasons > **randomOpacity**: `boolean` = `false` -Defined in: [src/brushes/SprayBrush.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L60) +Defined in: [src/brushes/SprayBrush.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L60) Whether opacity of a dot should be random @@ -147,7 +147,7 @@ Whether opacity of a dot should be random > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) = `null` -Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L29) +Defined in: [src/brushes/BaseBrush.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L29) Shadow object representing shadow of this shape. Backwards incompatibility note: This property replaces "shadowColor" (String), "shadowOffsetX" (Number), @@ -163,7 +163,7 @@ Shadow object representing shadow of this shape. > **strokeDashArray**: `null` \| `number`[] = `null` -Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L53) +Defined in: [src/brushes/BaseBrush.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L53) Stroke Dash Array. @@ -177,7 +177,7 @@ Stroke Dash Array. > **strokeLineCap**: `CanvasLineCap` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L35) +Defined in: [src/brushes/BaseBrush.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L35) Line endings style of a brush (one of "butt", "round", "square") @@ -191,7 +191,7 @@ Line endings style of a brush (one of "butt", "round", "square") > **strokeLineJoin**: `CanvasLineJoin` = `'round'` -Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L41) +Defined in: [src/brushes/BaseBrush.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L41) Corner style of a brush (one of "bevel", "round", "miter") @@ -205,7 +205,7 @@ Corner style of a brush (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` = `10` -Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/BaseBrush.ts#L47) +Defined in: [src/brushes/BaseBrush.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/BaseBrush.ts#L47) Maximum miter length (used for strokeLineJoin = "miter") of a brush's @@ -219,7 +219,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of a brush's > **width**: `number` = `10` -Defined in: [src/brushes/SprayBrush.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L36) +Defined in: [src/brushes/SprayBrush.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L36) Width of a spray @@ -233,7 +233,7 @@ Width of a spray > **\_render**(): `void` -Defined in: [src/brushes/SprayBrush.ts:171](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L171) +Defined in: [src/brushes/SprayBrush.ts:171](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L171) Render all spray chunks @@ -251,7 +251,7 @@ Render all spray chunks > **addSprayChunk**(`pointer`): `void` -Defined in: [src/brushes/SprayBrush.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L186) +Defined in: [src/brushes/SprayBrush.ts:186](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L186) #### Parameters @@ -269,7 +269,7 @@ Defined in: [src/brushes/SprayBrush.ts:186](https://github.com/fabricjs/fabric.j > **onMouseDown**(`pointer`): `void` -Defined in: [src/brushes/SprayBrush.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L87) +Defined in: [src/brushes/SprayBrush.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L87) Invoked on mouse down @@ -293,7 +293,7 @@ Invoked on mouse down > **onMouseMove**(`pointer`): `void` -Defined in: [src/brushes/SprayBrush.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L100) +Defined in: [src/brushes/SprayBrush.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L100) Invoked on mouse move @@ -317,7 +317,7 @@ Invoked on mouse move > **onMouseUp**(): `void` -Defined in: [src/brushes/SprayBrush.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L111) +Defined in: [src/brushes/SprayBrush.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L111) Invoked on mouse up @@ -335,7 +335,7 @@ Invoked on mouse up > **renderChunck**(`sprayChunck`): `void` -Defined in: [src/brushes/SprayBrush.ts:153](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/SprayBrush.ts#L153) +Defined in: [src/brushes/SprayBrush.ts:153](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/SprayBrush.ts#L153) #### Parameters diff --git a/src/content/docs/api/classes/StaticCanvas.md b/src/content/docs/api/classes/StaticCanvas.md index 03d3e557..163c810b 100644 --- a/src/content/docs/api/classes/StaticCanvas.md +++ b/src/content/docs/api/classes/StaticCanvas.md @@ -5,7 +5,7 @@ prev: false title: "StaticCanvas" --- -Defined in: [src/canvas/StaticCanvas.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L89) +Defined in: [src/canvas/StaticCanvas.ts:93](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L93) Static canvas class @@ -53,7 +53,7 @@ object:removed > **new StaticCanvas**\<`EventSpec`\>(`el?`, `options?`): `StaticCanvas`\<`EventSpec`\> -Defined in: [src/canvas/StaticCanvas.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L195) +Defined in: [src/canvas/StaticCanvas.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L199) #### Parameters @@ -79,7 +79,7 @@ Defined in: [src/canvas/StaticCanvas.ts:195](https://github.com/fabricjs/fabric. > **\_objects**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] = `[]` -Defined in: [src/Collection.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L21) +Defined in: [src/Collection.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L21) #### TODO @@ -95,7 +95,7 @@ needs to end up in the constructor too > **\_offset**: `object` -Defined in: [src/canvas/StaticCanvas.ts:162](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L162) +Defined in: [src/canvas/StaticCanvas.ts:166](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L166) #### left @@ -111,7 +111,7 @@ Defined in: [src/canvas/StaticCanvas.ts:162](https://github.com/fabricjs/fabric. > **allowTouchScrolling**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:126](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L126) +Defined in: [src/canvas/StaticCanvas.ts:130](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L130) #### Todo @@ -127,7 +127,7 @@ move to Canvas > **backgroundColor**: `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/canvas/StaticCanvas.ts:101](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L101) +Defined in: [src/canvas/StaticCanvas.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L105) Background color of canvas instance. @@ -141,7 +141,7 @@ Background color of canvas instance. > `optional` **backgroundImage**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvas.ts:102](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L102) +Defined in: [src/canvas/StaticCanvas.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L106) Background image of canvas instance. since 2.4.0 image caching is active, please when putting an image as background, add to the @@ -158,7 +158,7 @@ vale. As an alternative you can disable image objectCaching > **backgroundVpt**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L100) +Defined in: [src/canvas/StaticCanvas.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L104) if set to false background image is not affected by viewport transform @@ -180,7 +180,7 @@ we should really find a different way to do this > `optional` **clipPath**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvas.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L108) +Defined in: [src/canvas/StaticCanvas.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L112) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the canvas has rendered, and the context is placed in the @@ -197,7 +197,7 @@ clipPath will clip away controls, if you do not want this to happen use controls > **controlsAboveOverlay**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L121) +Defined in: [src/canvas/StaticCanvas.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L125) #### Todo @@ -213,7 +213,7 @@ move to Canvas > `optional` **destroyed**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:153](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L153) +Defined in: [src/canvas/StaticCanvas.ts:157](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L157) If true the Canvas is in the process or has been disposed/destroyed. No more rendering operation will be executed on this canvas. @@ -224,7 +224,7 @@ No more rendering operation will be executed on this canvas. > `optional` **disposed**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:160](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L160) +Defined in: [src/canvas/StaticCanvas.ts:164](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L164) Started the process of disposing but not done yet. WIll likely complete the render cycle already scheduled but stopping adding more. @@ -235,7 +235,7 @@ WIll likely complete the render cycle already scheduled but stopping adding more > **elements**: [`StaticCanvasDOMManager`](/api/classes/staticcanvasdommanager/) -Defined in: [src/canvas/StaticCanvas.ts:166](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L166) +Defined in: [src/canvas/StaticCanvas.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L170) *** @@ -243,7 +243,7 @@ Defined in: [src/canvas/StaticCanvas.ts:166](https://github.com/fabricjs/fabric. > **enableRetinaScaling**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L115) +Defined in: [src/canvas/StaticCanvas.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L119) When true, canvas is scaled by devicePixelRatio for better rendering on retina screens @@ -257,7 +257,7 @@ When true, canvas is scaled by devicePixelRatio for better rendering on retina s > **height**: `number` -Defined in: [src/canvas/StaticCanvas.ts:97](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L97) +Defined in: [src/canvas/StaticCanvas.ts:101](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L101) Height in virtual/logical pixels of the canvas. The canvas can be taller than width if retina scaling is active @@ -272,7 +272,7 @@ The canvas can be taller than width if retina scaling is active > **imageSmoothingEnabled**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L116) +Defined in: [src/canvas/StaticCanvas.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L120) Indicates whether this canvas will use image smoothing, this is on by default in browsers @@ -286,7 +286,7 @@ Indicates whether this canvas will use image smoothing, this is on by default in > **includeDefaultValues**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L110) +Defined in: [src/canvas/StaticCanvas.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L114) Indicates whether toObject/toDatalessObject should include default values if set to false, takes precedence over the object value. @@ -301,7 +301,7 @@ if set to false, takes precedence over the object value. > **overlayColor**: `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/canvas/StaticCanvas.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L105) +Defined in: [src/canvas/StaticCanvas.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L109) Overlay color of canvas instance. @@ -319,7 +319,7 @@ Overlay color of canvas instance. > `optional` **overlayImage**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvas.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L106) +Defined in: [src/canvas/StaticCanvas.ts:110](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L110) Overlay image of canvas instance. since 2.4.0 image caching is active, please when putting an image as overlay, add to the @@ -336,7 +336,7 @@ vale. As an alternative you can disable image objectCaching > **overlayVpt**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L104) +Defined in: [src/canvas/StaticCanvas.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L108) if set to false overlay image is not affected by viewport transform @@ -358,7 +358,7 @@ we should really find a different way to do this > **patternQuality**: `PatternQuality` -Defined in: [src/canvas/StaticCanvas.ts:181](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L181) +Defined in: [src/canvas/StaticCanvas.ts:185](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L185) Controls the rendering of images under node-canvas. Has no effects on the browser context. @@ -369,7 +369,7 @@ Has no effects on the browser context. > **renderOnAddRemove**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L113) +Defined in: [src/canvas/StaticCanvas.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L117) Indicates whether [StaticCanvas#add](/api/classes/staticcanvas/#add), [StaticCanvas#insertAt](/api/classes/staticcanvas/#insertat) and StaticCanvas#remove, StaticCanvas#moveTo, [StaticCanvas#clear](/api/classes/staticcanvas/#clear) and many more, should also re-render canvas. @@ -388,7 +388,7 @@ Left default to true to do not break documentation and old app, fiddles. > **skipOffscreen**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L114) +Defined in: [src/canvas/StaticCanvas.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L118) Based on vptCoords and object.aCoords, skip rendering of objects that are not included in current viewport. @@ -412,7 +412,7 @@ true > **svgViewportTransformation**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:909](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L909) +Defined in: [src/canvas/StaticCanvas.ts:913](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L913) When true, getSvgTransform() will apply the StaticCanvas.viewportTransform to the SVG transformation. When true, a zoomed canvas will then produce zoomed SVG output. @@ -427,7 +427,7 @@ a zoomed canvas will then produce zoomed SVG output. > **viewportTransform**: [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/canvas/StaticCanvas.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L128) +Defined in: [src/canvas/StaticCanvas.ts:132](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L132) The transformation (a Canvas 2D API transform matrix) which focuses the viewport @@ -451,7 +451,7 @@ canvas.viewportTransform = [0.7, 0, 0, 0.7, 50, 50]; > **vptCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/canvas/StaticCanvas.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L133) +Defined in: [src/canvas/StaticCanvas.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L137) The viewport bounding box in scene plane coordinates, see [calcViewportBoundaries](/api/classes/staticcanvas/#calcviewportboundaries) @@ -461,7 +461,7 @@ The viewport bounding box in scene plane coordinates, see [calcViewportBoundarie > **width**: `number` -Defined in: [src/canvas/StaticCanvas.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L96) +Defined in: [src/canvas/StaticCanvas.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L100) Width in virtual/logical pixels of the canvas. The canvas can be larger than width if retina scaling is active @@ -476,7 +476,7 @@ The canvas can be larger than width if retina scaling is active > `static` **ownDefaults**: [`TOptions`](/api/type-aliases/toptions/)\<[`StaticCanvasOptions`](/api/interfaces/staticcanvasoptions/)\> = `staticCanvasDefaults` -Defined in: [src/canvas/StaticCanvas.ts:183](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L183) +Defined in: [src/canvas/StaticCanvas.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L187) ## Accessors @@ -486,7 +486,7 @@ Defined in: [src/canvas/StaticCanvas.ts:183](https://github.com/fabricjs/fabric. > **get** **contextContainer**(): `CanvasRenderingContext2D` -Defined in: [src/canvas/StaticCanvas.ts:144](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L144) +Defined in: [src/canvas/StaticCanvas.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L148) ##### Returns @@ -500,7 +500,7 @@ Defined in: [src/canvas/StaticCanvas.ts:144](https://github.com/fabricjs/fabric. > **get** **lowerCanvasEl**(): `HTMLCanvasElement` -Defined in: [src/canvas/StaticCanvas.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L140) +Defined in: [src/canvas/StaticCanvas.ts:144](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L144) A reference to the canvas actual HTMLCanvasElement. Can be use to read the raw pixels, but never write or manipulate @@ -515,7 +515,7 @@ Can be use to read the raw pixels, but never write or manipulate > **\_onObjectAdded**(`obj`): `void` -Defined in: [src/canvas/StaticCanvas.ts:237](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L237) +Defined in: [src/canvas/StaticCanvas.ts:241](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L241) #### Parameters @@ -537,7 +537,7 @@ Defined in: [src/canvas/StaticCanvas.ts:237](https://github.com/fabricjs/fabric. > **\_onObjectRemoved**(`obj`): `void` -Defined in: [src/canvas/StaticCanvas.ts:252](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L252) +Defined in: [src/canvas/StaticCanvas.ts:256](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L256) #### Parameters @@ -559,7 +559,7 @@ Defined in: [src/canvas/StaticCanvas.ts:252](https://github.com/fabricjs/fabric. > **\_onStackOrderChanged**(): `void` -Defined in: [src/canvas/StaticCanvas.ts:258](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L258) +Defined in: [src/canvas/StaticCanvas.ts:262](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L262) #### Returns @@ -575,7 +575,7 @@ Defined in: [src/canvas/StaticCanvas.ts:258](https://github.com/fabricjs/fabric. > **\_set**(`key`, `value`): `void` -Defined in: [src/CommonMethods.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L38) +Defined in: [src/CommonMethods.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L38) #### Parameters @@ -601,7 +601,7 @@ Defined in: [src/CommonMethods.ts:38](https://github.com/fabricjs/fabric.js/blob > **absolutePan**(`point`): `void` -Defined in: [src/canvas/StaticCanvas.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L400) +Defined in: [src/canvas/StaticCanvas.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L404) Pan viewport so as to place point at top left corner of canvas @@ -623,7 +623,7 @@ to move to > **add**(...`objects`): `number` -Defined in: [src/canvas/StaticCanvas.ts:219](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L219) +Defined in: [src/canvas/StaticCanvas.ts:223](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L223) Adds objects to collection Objects should be instances of (or inherit from) FabricObject @@ -652,7 +652,7 @@ new array length > **bringObjectForward**(`object`, `intersecting?`): `boolean` -Defined in: [src/Collection.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L240) +Defined in: [src/Collection.ts:240](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L240) Moves an object or a selection up in stack of drawn objects An optional parameter, intersecting allows to move the object in front @@ -690,7 +690,7 @@ true if change occurred > **bringObjectToFront**(`object`): `boolean` -Defined in: [src/Collection.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L194) +Defined in: [src/Collection.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L194) Moves an object or the objects of a multiple selection to the top of the stack of drawn objects @@ -719,7 +719,7 @@ true if change occurred > **calcOffset**(): `object` -Defined in: [src/canvas/StaticCanvas.ts:275](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L275) +Defined in: [src/canvas/StaticCanvas.ts:279](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L279) Calculates canvas element offset relative to the document This method is also attached as "resize" event handler of window @@ -742,7 +742,7 @@ This method is also attached as "resize" event handler of window > **calcViewportBoundaries**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/canvas/StaticCanvas.ts:497](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L497) +Defined in: [src/canvas/StaticCanvas.ts:501](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L501) Calculate the position of the 4 corner of canvas with current viewportTransform. helps to determinate when an object is in the current rendering viewport @@ -757,7 +757,7 @@ helps to determinate when an object is in the current rendering viewport > **cancelRequestedRender**(): `void` -Defined in: [src/canvas/StaticCanvas.ts:515](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L515) +Defined in: [src/canvas/StaticCanvas.ts:519](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L519) #### Returns @@ -769,7 +769,7 @@ Defined in: [src/canvas/StaticCanvas.ts:515](https://github.com/fabricjs/fabric. > **centerObject**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L712) +Defined in: [src/canvas/StaticCanvas.ts:716](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L716) Centers object vertically and horizontally in the canvas @@ -791,7 +791,7 @@ Object to center vertically and horizontally > **centerObjectH**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:690](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L690) +Defined in: [src/canvas/StaticCanvas.ts:694](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L694) Centers object horizontally in the canvas @@ -811,7 +811,7 @@ Centers object horizontally in the canvas > **centerObjectV**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L701) +Defined in: [src/canvas/StaticCanvas.ts:705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L705) Centers object vertically in the canvas @@ -833,7 +833,7 @@ Object to center vertically > **clear**(): `void` -Defined in: [src/canvas/StaticCanvas.ts:447](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L447) +Defined in: [src/canvas/StaticCanvas.ts:451](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L451) Clears all contexts (background, main, top) of an instance @@ -847,7 +847,7 @@ Clears all contexts (background, main, top) of an instance > **clearContext**(`ctx`): `void` -Defined in: [src/canvas/StaticCanvas.ts:432](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L432) +Defined in: [src/canvas/StaticCanvas.ts:436](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L436) Clears specified context of canvas element @@ -869,7 +869,7 @@ Context to clear > **clone**(`properties?`): `Promise`\<`StaticCanvas`\<`EventSpec`\>\> -Defined in: [src/canvas/StaticCanvas.ts:1278](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1278) +Defined in: [src/canvas/StaticCanvas.ts:1287](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1287) Clones canvas instance @@ -891,7 +891,7 @@ Array of properties to include in the cloned canvas and children > **cloneWithoutData**(): `StaticCanvas`\<`EventSpec`\> -Defined in: [src/canvas/StaticCanvas.ts:1288](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1288) +Defined in: [src/canvas/StaticCanvas.ts:1297](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1297) Clones canvas instance without cloning existing data. This essentially copies canvas dimensions since loadFromJSON does not affect canvas size. @@ -906,7 +906,7 @@ This essentially copies canvas dimensions since loadFromJSON does not affect can > **collectObjects**(`bbox`, `options`): [`InteractiveFabricObject`](/api/classes/interactivefabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/Collection.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L326) +Defined in: [src/Collection.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L326) Given a bounding box, return all the objects of the collection that are contained in the bounding box. If `includeIntersecting` is true, return also the objects that intersect the bounding box as well. @@ -944,7 +944,7 @@ array of objects contained in the bounding box, ordered from top to bottom stack > **complexity**(): `number` -Defined in: [src/Collection.ts:165](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L165) +Defined in: [src/Collection.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L165) Returns number representation of a collection complexity @@ -964,7 +964,7 @@ complexity > **contains**(`object`, `deep?`): `boolean` -Defined in: [src/Collection.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L148) +Defined in: [src/Collection.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L148) Returns true if collection contains an object.\ **Prefer using [FabricObject#isDescendantOf](/api/classes/fabricobject/#isdescendantof) for performance reasons** @@ -1000,7 +1000,7 @@ Object to check against > **createSVGClipPathMarkup**(`options`): `string` -Defined in: [src/canvas/StaticCanvas.ts:1036](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1036) +Defined in: [src/canvas/StaticCanvas.ts:1040](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1040) #### Parameters @@ -1018,7 +1018,7 @@ Defined in: [src/canvas/StaticCanvas.ts:1036](https://github.com/fabricjs/fabric > **createSVGFontFacesMarkup**(): `string` -Defined in: [src/canvas/StaticCanvas.ts:1079](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1079) +Defined in: [src/canvas/StaticCanvas.ts:1083](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1083) Creates markup containing SVG font faces, font URLs for font faces must be collected by developers @@ -1034,7 +1034,7 @@ and are not extracted from the DOM by fabricjs > **createSVGRefElementsMarkup**(): `string` -Defined in: [src/canvas/StaticCanvas.ts:1051](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1051) +Defined in: [src/canvas/StaticCanvas.ts:1055](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1055) Creates markup containing SVG referenced elements like patterns, gradients etc. @@ -1048,7 +1048,7 @@ Creates markup containing SVG referenced elements like patterns, gradients etc. > **dispose**(): `Promise`\<`boolean`\> -Defined in: [src/canvas/StaticCanvas.ts:1422](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1422) +Defined in: [src/canvas/StaticCanvas.ts:1431](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1431) Waits until rendering has settled to destroy the canvas @@ -1068,7 +1068,7 @@ if aborted by a consequent call > **drawClipPathOnCanvas**(`ctx`, `clipPath`): `void` -Defined in: [src/canvas/StaticCanvas.ts:579](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L579) +Defined in: [src/canvas/StaticCanvas.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L583) Paint the cached clipPath on the lowerCanvasEl @@ -1094,7 +1094,7 @@ Context to render on > **drawControls**(`_ctx`): `void` -Defined in: [src/canvas/StaticCanvas.ts:522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L522) +Defined in: [src/canvas/StaticCanvas.ts:526](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L526) #### Parameters @@ -1112,7 +1112,7 @@ Defined in: [src/canvas/StaticCanvas.ts:522](https://github.com/fabricjs/fabric. > **findNewLowerIndex**(`object`, `idx`, `intersecting?`): `number` -Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L272) +Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L272) #### Parameters @@ -1142,7 +1142,7 @@ Defined in: [src/Collection.ts:272](https://github.com/fabricjs/fabric.js/blob/2 > **findNewUpperIndex**(`object`, `idx`, `intersecting?`): `number` -Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L295) +Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L295) #### Parameters @@ -1172,7 +1172,7 @@ Defined in: [src/Collection.ts:295](https://github.com/fabricjs/fabric.js/blob/2 > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -1210,7 +1210,7 @@ Options object > **forEachObject**(`callback`): `void` -Defined in: [src/Collection.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L91) +Defined in: [src/Collection.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L91) Executes given function for each object in this group A simple shortcut for getObjects().forEach, before es6 was more complicated, @@ -1239,7 +1239,7 @@ Callback invoked with current object as first argument, > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -1267,7 +1267,7 @@ value of a property > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/canvas/StaticCanvas.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L683) +Defined in: [src/canvas/StaticCanvas.ts:687](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L687) Returns coordinates of a center of canvas. @@ -1281,7 +1281,7 @@ Returns coordinates of a center of canvas. > **getContext**(): `CanvasRenderingContext2D` -Defined in: [src/canvas/StaticCanvas.ts:440](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L440) +Defined in: [src/canvas/StaticCanvas.ts:444](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L444) Returns context of canvas where objects are drawn @@ -1295,7 +1295,7 @@ Returns context of canvas where objects are drawn > **getElement**(): `HTMLCanvasElement` -Defined in: [src/canvas/StaticCanvas.ts:424](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L424) +Defined in: [src/canvas/StaticCanvas.ts:428](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L428) Returns <canvas> element corresponding to this instance @@ -1309,7 +1309,7 @@ Returns <canvas> element corresponding to this instance > **getHeight**(): `number` -Defined in: [src/canvas/StaticCanvas.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L291) +Defined in: [src/canvas/StaticCanvas.ts:295](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L295) Returns canvas height (in px) @@ -1323,7 +1323,7 @@ Returns canvas height (in px) > **getObjects**(...`types?`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/Collection.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L108) +Defined in: [src/Collection.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L108) Returns an array of children objects of this instance @@ -1349,7 +1349,7 @@ When specified, only objects of these types are returned > **getVpCenter**(): [`Point`](/api/classes/point/) -Defined in: [src/canvas/StaticCanvas.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L750) +Defined in: [src/canvas/StaticCanvas.ts:754](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L754) Calculate the point in canvas that correspond to the center of actual viewport. @@ -1365,7 +1365,7 @@ vpCenter, viewport center > **getWidth**(): `number` -Defined in: [src/canvas/StaticCanvas.ts:283](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L283) +Defined in: [src/canvas/StaticCanvas.ts:287](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L287) Returns canvas width (in px) @@ -1379,9 +1379,9 @@ Returns canvas width (in px) > **getZoom**(): `number` -Defined in: [src/canvas/StaticCanvas.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L353) +Defined in: [src/canvas/StaticCanvas.ts:357](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L357) -Returns canvas zoom level +Returns the canvas zoom level as the magnitude of the viewport scale. #### Returns @@ -1393,7 +1393,7 @@ Returns canvas zoom level > **insertAt**(`index`, ...`objects`): `number` -Defined in: [src/canvas/StaticCanvas.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L225) +Defined in: [src/canvas/StaticCanvas.ts:229](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L229) Inserts an object into collection at specified index @@ -1427,7 +1427,7 @@ new array length > **isEmpty**(): `boolean` -Defined in: [src/Collection.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L128) +Defined in: [src/Collection.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L128) Returns true if collection contains no objects @@ -1447,7 +1447,7 @@ true if collection is empty > **item**(`index`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/Collection.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L120) +Defined in: [src/Collection.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L120) Returns object at specified index @@ -1473,7 +1473,7 @@ object at index > **loadFromJSON**(`json`, `reviver?`, `options?`): `Promise`\<`StaticCanvas`\<`EventSpec`\>\> -Defined in: [src/canvas/StaticCanvas.ts:1232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1232) +Defined in: [src/canvas/StaticCanvas.ts:1241](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1241) Populates canvas with data from the specified JSON. JSON format must conform to the one of fabric.Canvas#toJSON @@ -1490,9 +1490,10 @@ JSON string or object ##### reviver? -\<`T`\>(`serializedObj`, `instance`) => `void` +\<`T`\>(`serializedObj`, `instance`, `error?`) => `void` \| `Promise`\<`T`\> -Method for further parsing of JSON elements, called after each fabric object created. +Method for further parsing of JSON elements, called after each fabric object created with the instance +if creation was successfully or with defined error if not. If a FabricObject is returned in the reviver, and an error occurred, this instance will be used in place of that one witch generated error. ##### options? @@ -1518,10 +1519,14 @@ canvas.loadFromJSON(json).then((canvas) => canvas.requestRenderAll()); ``` ```ts -canvas.loadFromJSON(json, function(o, object) { +canvas.loadFromJSON(json, function(o, object, error) { // `o` = json object - // `object` = fabric.Object instance + // `object` = fabric.Object instance or undefined + // `error` = FabricError or undefined // ... do some stuff ... + if(error){ + return new FabricText('placeholder-object'); + } }).then((canvas) => { ... canvas is restored, add your code. }); @@ -1533,7 +1538,7 @@ canvas.loadFromJSON(json, function(o, object) { > **moveObjectTo**(`object`, `index`): `boolean` -Defined in: [src/Collection.ts:262](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L262) +Defined in: [src/Collection.ts:262](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L262) Moves an object to specified level in stack of drawn objects @@ -1569,7 +1574,7 @@ true if change occurred > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -1605,7 +1610,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -1641,7 +1646,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -1665,7 +1670,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -1685,7 +1690,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -1731,7 +1736,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -1765,7 +1770,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -1811,7 +1816,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -1843,7 +1848,7 @@ once > **relativePan**(`point`): `void` -Defined in: [src/canvas/StaticCanvas.ts:411](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L411) +Defined in: [src/canvas/StaticCanvas.ts:415](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L415) Pans viewpoint relatively @@ -1865,7 +1870,7 @@ Pans viewpoint relatively > **renderAll**(): `void` -Defined in: [src/canvas/StaticCanvas.ts:461](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L461) +Defined in: [src/canvas/StaticCanvas.ts:465](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L465) Renders the canvas @@ -1879,7 +1884,7 @@ Renders the canvas > **renderCanvas**(`ctx`, `objects`): `void` -Defined in: [src/canvas/StaticCanvas.ts:531](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L531) +Defined in: [src/canvas/StaticCanvas.ts:535](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L535) Renders background, objects, overlay and controls. @@ -1905,7 +1910,7 @@ to render > **requestRenderAll**(): `void` -Defined in: [src/canvas/StaticCanvas.ts:487](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L487) +Defined in: [src/canvas/StaticCanvas.ts:491](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L491) Append a renderAll request to next animation frame. unless one is already in progress, in that case nothing is done @@ -1921,7 +1926,7 @@ a boolean flag will avoid appending more. > **sendObjectBackwards**(`object`, `intersecting?`): `boolean` -Defined in: [src/Collection.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L214) +Defined in: [src/Collection.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L214) Moves an object or a selection down in stack of drawn objects An optional parameter, `intersecting` allows to move the object in behind @@ -1959,7 +1964,7 @@ true if change occurred > **sendObjectToBack**(`object`): `boolean` -Defined in: [src/Collection.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L178) +Defined in: [src/Collection.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L178) Moves an object or the objects of a multiple selection to the bottom of the stack of drawn objects @@ -1988,7 +1993,7 @@ true if change occurred > **set**(`key`, `value?`): `StaticCanvas`\<`EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -2022,7 +2027,7 @@ Property value (if function, the value is passed into it and its return value is > **setDimensions**(`dimensions`, `options?`): `void` -Defined in: [src/canvas/StaticCanvas.ts:330](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L330) +Defined in: [src/canvas/StaticCanvas.ts:334](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L334) Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em) @@ -2058,7 +2063,7 @@ Set the given dimensions only as css dimensions > **setDimensions**(`dimensions`, `options?`): `void` -Defined in: [src/canvas/StaticCanvas.ts:334](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L334) +Defined in: [src/canvas/StaticCanvas.ts:338](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L338) Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em) @@ -2094,7 +2099,7 @@ Set the given dimensions only as css dimensions > **setDimensions**(`dimensions`, `options?`): `void` -Defined in: [src/canvas/StaticCanvas.ts:338](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L338) +Defined in: [src/canvas/StaticCanvas.ts:342](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L342) Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em) @@ -2122,7 +2127,7 @@ Options object > **setViewportTransform**(`vpt`): `void` -Defined in: [src/canvas/StaticCanvas.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L361) +Defined in: [src/canvas/StaticCanvas.ts:365](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L365) Sets viewport transformation of this canvas instance @@ -2144,7 +2149,7 @@ a Canvas 2D API transform matrix > **setZoom**(`value`): `void` -Defined in: [src/canvas/StaticCanvas.ts:392](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L392) +Defined in: [src/canvas/StaticCanvas.ts:396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L396) Sets zoom level of this canvas instance @@ -2166,7 +2171,7 @@ to set zoom to, less than 1 zooms out > **size**(): `number` -Defined in: [src/Collection.ts:136](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L136) +Defined in: [src/Collection.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L136) Returns a size of a collection (i.e: length of an array containing its objects) @@ -2186,7 +2191,7 @@ Collection size > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/canvas/StaticCanvas.ts:1347](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1347) +Defined in: [src/canvas/StaticCanvas.ts:1356](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1356) #### Parameters @@ -2204,7 +2209,7 @@ Defined in: [src/canvas/StaticCanvas.ts:1347](https://github.com/fabricjs/fabric > **toCanvasElement**(`multiplier?`, `options?`): `HTMLCanvasElement` -Defined in: [src/canvas/StaticCanvas.ts:1378](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1378) +Defined in: [src/canvas/StaticCanvas.ts:1387](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1387) Create a new HTMLCanvas element painted with the current canvas content. No need to resize the actual one or repaint it. @@ -2236,7 +2241,7 @@ Cropping informations > **toDatalessJSON**(`propertiesToInclude?`): `any` -Defined in: [src/canvas/StaticCanvas.ts:773](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L773) +Defined in: [src/canvas/StaticCanvas.ts:777](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L777) Returns dataless JSON representation of canvas @@ -2260,7 +2265,7 @@ json string > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/canvas/StaticCanvas.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L809) +Defined in: [src/canvas/StaticCanvas.ts:813](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L813) Returns dataless object representation of canvas @@ -2284,7 +2289,7 @@ object representation of an instance > **toDataURL**(`options?`): `string` -Defined in: [src/canvas/StaticCanvas.ts:1331](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1331) +Defined in: [src/canvas/StaticCanvas.ts:1340](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1340) Exports canvas element to a dataurl image. Note that when multiplier is used, cropping is scaled appropriately @@ -2345,7 +2350,7 @@ var dataURL = canvas.toDataURL({ > **toggle**(`property`): `StaticCanvas`\<`EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -2371,7 +2376,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/canvas/StaticCanvas.ts:800](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L800) +Defined in: [src/canvas/StaticCanvas.ts:804](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L804) Returns Object representation of canvas this alias is provided because if you call JSON.stringify on an instance, @@ -2406,7 +2411,7 @@ const json = JSON.stringify(canvas); > **toObject**(`propertiesToInclude?`): `any` -Defined in: [src/canvas/StaticCanvas.ts:782](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L782) +Defined in: [src/canvas/StaticCanvas.ts:786](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L786) Returns object representation of canvas @@ -2430,7 +2435,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/canvas/StaticCanvas.ts:1481](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L1481) +Defined in: [src/canvas/StaticCanvas.ts:1490](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L1490) Returns a string representation of an instance @@ -2446,7 +2451,7 @@ string representation of an instance > **toSVG**(`options?`, `reviver?`): `string` -Defined in: [src/canvas/StaticCanvas.ts:947](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L947) +Defined in: [src/canvas/StaticCanvas.ts:951](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L951) Returns SVG representation of canvas @@ -2512,7 +2517,7 @@ var svg = canvas.toSVG(null, function(svg) { > **viewportCenterObject**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:720](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L720) +Defined in: [src/canvas/StaticCanvas.ts:724](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L724) Centers object vertically and horizontally in the viewport @@ -2534,7 +2539,7 @@ Object to center vertically and horizontally > **viewportCenterObjectH**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:728](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L728) +Defined in: [src/canvas/StaticCanvas.ts:732](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L732) Centers object horizontally in the viewport, object.top is unchanged @@ -2556,7 +2561,7 @@ Object to center vertically and horizontally > **viewportCenterObjectV**(`object`): `void` -Defined in: [src/canvas/StaticCanvas.ts:739](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L739) +Defined in: [src/canvas/StaticCanvas.ts:743](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L743) Centers object Vertically in the viewport, object.top is unchanged @@ -2578,7 +2583,7 @@ Object to center vertically and horizontally > **zoomToPoint**(`point`, `value`): `void` -Defined in: [src/canvas/StaticCanvas.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L375) +Defined in: [src/canvas/StaticCanvas.ts:379](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L379) Sets zoom level of this canvas instance, the zoom centered around point meaning that following zoom to point with the same point will have the visual @@ -2609,7 +2614,7 @@ to set zoom to, less than 1 zooms out > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/canvas/StaticCanvas.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L191) +Defined in: [src/canvas/StaticCanvas.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L195) #### Returns diff --git a/src/content/docs/api/classes/StaticCanvasDOMManager.md b/src/content/docs/api/classes/StaticCanvasDOMManager.md index a7d29853..21213004 100644 --- a/src/content/docs/api/classes/StaticCanvasDOMManager.md +++ b/src/content/docs/api/classes/StaticCanvasDOMManager.md @@ -5,7 +5,7 @@ prev: false title: "StaticCanvasDOMManager" --- -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L14) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L14) ## Extended by @@ -17,7 +17,7 @@ Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:14](https://github > **new StaticCanvasDOMManager**(`arg0?`): `StaticCanvasDOMManager` -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L24) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L24) #### Parameters @@ -35,7 +35,7 @@ Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:24](https://github > **lower**: `CanvasItem` -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L22) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L22) ## Methods @@ -43,7 +43,7 @@ Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:22](https://github > **calcOffset**(): `object` -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L71) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L71) Calculates canvas element offset relative to the document @@ -65,7 +65,7 @@ Calculates canvas element offset relative to the document > **cleanupDOM**(`__namedParameters`): `void` -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L47) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L47) #### Parameters @@ -83,7 +83,7 @@ Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:47](https://github > **dispose**(): `void` -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L75) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L75) #### Returns @@ -95,7 +95,7 @@ Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:75](https://github > **setCSSDimensions**(`size`): `void` -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L64) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L64) #### Parameters @@ -113,7 +113,7 @@ Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:64](https://github > **setDimensions**(`size`, `retinaScaling`): `void` -Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L59) +Defined in: [src/canvas/DOMManagers/StaticCanvasDOMManager.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/DOMManagers/StaticCanvasDOMManager.ts#L59) #### Parameters diff --git a/src/content/docs/api/classes/Textbox.md b/src/content/docs/api/classes/Textbox.md index 8fefb92f..dcf57192 100644 --- a/src/content/docs/api/classes/Textbox.md +++ b/src/content/docs/api/classes/Textbox.md @@ -5,7 +5,7 @@ prev: false title: "Textbox" --- -Defined in: [src/shapes/Textbox.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L55) +Defined in: [src/shapes/Textbox.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L55) Textbox class, based on IText, allows the user to resize the text rectangle and wraps lines automatically. Textboxes have their Y scaling locked, the @@ -40,7 +40,7 @@ wrapping of lines. > **new Textbox**\<`Props`, `SProps`, `EventSpec`\>(`text`, `options?`): `Textbox`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Textbox.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L109) +Defined in: [src/shapes/Textbox.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L109) Constructor @@ -72,7 +72,7 @@ Options object > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -90,7 +90,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_\_lineHeights**: `number`[] -Defined in: [src/shapes/Text/Text.ts:416](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L416) +Defined in: [src/shapes/Text/Text.ts:426](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L426) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [src/shapes/Text/Text.ts:416](https://github.com/fabricjs/fabric.js/ > **\_\_lineWidths**: `number`[] -Defined in: [src/shapes/Text/Text.ts:417](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L417) +Defined in: [src/shapes/Text/Text.ts:427](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L427) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [src/shapes/Text/Text.ts:417](https://github.com/fabricjs/fabric.js/ > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -130,7 +130,7 @@ this takes priority over the generic control visibility > **\_fontSizeMult**: `number` -Defined in: [src/shapes/Text/Text.ts:351](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L351) +Defined in: [src/shapes/Text/Text.ts:361](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L361) Text Line proportion to font Size (in pixels) @@ -144,7 +144,7 @@ Text Line proportion to font Size (in pixels) > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -166,7 +166,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **\_styleMap**: `StyleMap` -Defined in: [src/shapes/Textbox.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L87) +Defined in: [src/shapes/Textbox.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L87) *** @@ -174,7 +174,7 @@ Defined in: [src/shapes/Textbox.ts:87](https://github.com/fabricjs/fabric.js/blo > **\_text**: `string`[] -Defined in: [src/shapes/Text/Text.ts:414](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L414) +Defined in: [src/shapes/Text/Text.ts:424](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L424) #### Inherited from @@ -186,7 +186,7 @@ Defined in: [src/shapes/Text/Text.ts:414](https://github.com/fabricjs/fabric.js/ > **\_textLines**: `string`[][] -Defined in: [src/shapes/Text/Text.ts:411](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L411) +Defined in: [src/shapes/Text/Text.ts:421](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L421) same as textlines, but each line is an array of graphemes as split by splitByGrapheme @@ -200,7 +200,7 @@ same as textlines, but each line is an array of graphemes as split by splitByGra > **\_unwrappedTextLines**: `string`[][] -Defined in: [src/shapes/Text/Text.ts:413](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L413) +Defined in: [src/shapes/Text/Text.ts:423](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L423) #### Inherited from @@ -212,7 +212,7 @@ Defined in: [src/shapes/Text/Text.ts:413](https://github.com/fabricjs/fabric.js/ > **\_wordJoiners**: `RegExp` -Defined in: [src/shapes/Textbox.ts:85](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L85) +Defined in: [src/shapes/Textbox.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L85) #### Implementation of @@ -224,7 +224,7 @@ Defined in: [src/shapes/Textbox.ts:85](https://github.com/fabricjs/fabric.js/blo > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -249,7 +249,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -268,7 +268,7 @@ You can calculate them without updating with [()](/api/classes/textbox/#calcacoo > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -288,7 +288,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -303,7 +303,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -323,7 +323,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -341,7 +341,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -361,7 +361,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -385,7 +385,7 @@ you will need to write your own render function for controls > **caching**: `boolean` -Defined in: [src/shapes/IText/IText.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L203) +Defined in: [src/shapes/IText/IText.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L203) Indicates whether internal text char widths can be cached @@ -399,7 +399,7 @@ Indicates whether internal text char widths can be cached > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -421,7 +421,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -440,7 +440,7 @@ when being scaled via the controls. > **charSpacing**: `number` -Defined in: [src/shapes/Text/Text.ts:358](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L358) +Defined in: [src/shapes/Text/Text.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L368) additional space between characters expressed in thousands of em unit @@ -455,7 +455,7 @@ expressed in thousands of em unit > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) #### Inherited from @@ -467,7 +467,7 @@ Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -482,7 +482,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **compositionColor**: `string` -Defined in: [src/shapes/IText/IText.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L197) +Defined in: [src/shapes/IText/IText.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L197) #### Inherited from @@ -494,7 +494,7 @@ Defined in: [src/shapes/IText/IText.ts:197](https://github.com/fabricjs/fabric.j > **compositionEnd**: `number` -Defined in: [src/shapes/IText/IText.ts:144](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L144) +Defined in: [src/shapes/IText/IText.ts:144](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L144) #### Inherited from @@ -506,7 +506,7 @@ Defined in: [src/shapes/IText/IText.ts:144](https://github.com/fabricjs/fabric.j > **compositionStart**: `number` -Defined in: [src/shapes/IText/IText.ts:142](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L142) +Defined in: [src/shapes/IText/IText.ts:142](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L142) #### Inherited from @@ -518,7 +518,7 @@ Defined in: [src/shapes/IText/IText.ts:142](https://github.com/fabricjs/fabric.j > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -533,7 +533,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -553,7 +553,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -577,7 +577,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -597,7 +597,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -621,7 +621,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -651,7 +651,7 @@ This API is no longer supported and may be removed in a future release. > **ctrlKeysMapDown**: `TKeyMapIText` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L42) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L42) For functionalities on keyDown + ctrl || cmd @@ -665,7 +665,7 @@ For functionalities on keyDown + ctrl || cmd > **ctrlKeysMapUp**: `TKeyMapIText` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L37) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L37) For functionalities on keyUp + ctrl || cmd @@ -679,7 +679,7 @@ For functionalities on keyUp + ctrl || cmd > **cursorColor**: `string` -Defined in: [src/shapes/IText/IText.ts:183](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L183) +Defined in: [src/shapes/IText/IText.ts:183](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L183) Color of text cursor color in editing mode. if not set (default) will take color from the text. @@ -696,7 +696,7 @@ be used instead of the color of the text at the current position. > **cursorDelay**: `number` -Defined in: [src/shapes/IText/IText.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L189) +Defined in: [src/shapes/IText/IText.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L189) Delay between cursor blink (in ms) @@ -710,7 +710,7 @@ Delay between cursor blink (in ms) > **cursorDuration**: `number` -Defined in: [src/shapes/IText/IText.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L195) +Defined in: [src/shapes/IText/IText.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L195) Duration of cursor fade in (in ms) @@ -724,7 +724,7 @@ Duration of cursor fade in (in ms) > **cursorWidth**: `number` -Defined in: [src/shapes/IText/IText.ts:174](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L174) +Defined in: [src/shapes/IText/IText.ts:174](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L174) Width of cursor (in px) @@ -738,7 +738,7 @@ Width of cursor (in px) > **deltaY**: `number` -Defined in: [src/shapes/Text/Text.ts:364](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L364) +Defined in: [src/shapes/Text/Text.ts:374](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L374) Baseline shift, styles only, keep at 0 for the main text object @@ -752,7 +752,7 @@ Baseline shift, styles only, keep at 0 for the main text object > **direction**: `CanvasDirection` -Defined in: [src/shapes/Text/Text.ts:376](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L376) +Defined in: [src/shapes/Text/Text.ts:386](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L386) WARNING: EXPERIMENTAL. NOT SUPPORTED YET determine the direction of the text. @@ -775,7 +775,7 @@ https://www.w3.org/International/questions/qa-bidi-unicode-controls > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -796,7 +796,7 @@ true > **dynamicMinWidth**: `number` -Defined in: [src/shapes/Textbox.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L75) +Defined in: [src/shapes/Textbox.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L75) Minimum calculated width of a textbox, in pixels. fixed to 2 so that an empty textbox cannot go to 0 @@ -812,7 +812,7 @@ and is still selectable without text. > **editable**: `boolean` -Defined in: [src/shapes/IText/IText.ts:162](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L162) +Defined in: [src/shapes/IText/IText.ts:162](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L162) Indicates whether a text can be edited @@ -826,7 +826,7 @@ Indicates whether a text can be edited > **editingBorderColor**: `string` -Defined in: [src/shapes/IText/IText.ts:168](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L168) +Defined in: [src/shapes/IText/IText.ts:168](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L168) Border color of text object while it's in editing mode @@ -840,7 +840,7 @@ Border color of text object while it's in editing mode > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -854,7 +854,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -872,7 +872,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) #### Inherited from @@ -884,7 +884,7 @@ Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -906,7 +906,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -926,7 +926,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -946,7 +946,7 @@ false > **fontFamily**: `string` -Defined in: [src/shapes/Text/Text.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L199) +Defined in: [src/shapes/Text/Text.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L201) Font family @@ -960,7 +960,7 @@ Font family > **fontSize**: `number` -Defined in: [src/shapes/Text/Text.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L187) +Defined in: [src/shapes/Text/Text.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L189) Font size (in pixels) @@ -974,7 +974,7 @@ Font size (in pixels) > **fontStyle**: `FontStyle` -Defined in: [src/shapes/Text/Text.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L230) +Defined in: [src/shapes/Text/Text.ts:232](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L232) Font style . Possible values: "", "normal", "italic" or "oblique". @@ -988,7 +988,7 @@ Font style . Possible values: "", "normal", "italic" or "oblique". > **fontWeight**: `string` \| `number` -Defined in: [src/shapes/Text/Text.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L193) +Defined in: [src/shapes/Text/Text.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L195) Font weight (e.g. bold, normal, 400, 600, 800) @@ -1002,7 +1002,7 @@ Font weight (e.g. bold, normal, 400, 600, 800) > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -1016,7 +1016,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -1030,7 +1030,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -1050,7 +1050,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -1064,7 +1064,7 @@ Object height > **hiddenTextarea**: `null` \| `HTMLTextAreaElement` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:44](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L44) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:44](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L44) #### Inherited from @@ -1076,7 +1076,7 @@ Defined in: [src/shapes/IText/ITextKeyBehavior.ts:44](https://github.com/fabricj > `optional` **hiddenTextareaContainer**: `null` \| `HTMLElement` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L53) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L53) DOM container to append the hiddenTextarea. An alternative to attaching to the document.body. @@ -1093,7 +1093,7 @@ also with modals event capturing that won't let the textarea take focus. > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -1113,7 +1113,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -1127,7 +1127,7 @@ When `false`, default object's values are not included in its serialization > `optional` **initialized**: `true` -Defined in: [src/shapes/Text/Text.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L418) +Defined in: [src/shapes/Text/Text.ts:428](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L428) #### Inherited from @@ -1139,7 +1139,7 @@ Defined in: [src/shapes/Text/Text.ts:418](https://github.com/fabricjs/fabric.js/ > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -1161,7 +1161,7 @@ false > **isEditing**: `boolean` -Defined in: [src/shapes/IText/IText.ts:156](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L156) +Defined in: [src/shapes/IText/IText.ts:156](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L156) Indicates whether text is in editing mode @@ -1175,7 +1175,7 @@ Indicates whether text is in editing mode > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -1190,7 +1190,7 @@ part of the move action. > **isWrapping**: `boolean` -Defined in: [src/shapes/Textbox.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L89) +Defined in: [src/shapes/Textbox.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L89) *** @@ -1198,7 +1198,7 @@ Defined in: [src/shapes/Textbox.ts:89](https://github.com/fabricjs/fabric.js/blo > **keysMap**: `TKeyMapIText` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L30) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L30) For functionalities on keyDown Map a special key to a function of the instance/prototype @@ -1220,7 +1220,7 @@ The function must be in IText.prototype.myFunction And will receive event as arg > **keysMapRtl**: `TKeyMapIText` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L32) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L32) #### Inherited from @@ -1232,7 +1232,7 @@ Defined in: [src/shapes/IText/ITextKeyBehavior.ts:32](https://github.com/fabricj > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -1254,7 +1254,7 @@ You can change this by setting originX > **lineHeight**: `number` -Defined in: [src/shapes/Text/Text.ts:236](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L236) +Defined in: [src/shapes/Text/Text.ts:238](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L238) Line height @@ -1268,7 +1268,7 @@ Line height > **linethrough**: `boolean` -Defined in: [src/shapes/Text/Text.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L217) +Defined in: [src/shapes/Text/Text.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L219) Text decoration linethrough. @@ -1282,7 +1282,7 @@ Text decoration linethrough. > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -1296,7 +1296,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -1310,7 +1310,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -1324,7 +1324,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -1338,7 +1338,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -1352,7 +1352,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -1366,7 +1366,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -1380,7 +1380,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -1394,7 +1394,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -1408,7 +1408,7 @@ storage cache for object full transform matrix > **MIN\_TEXT\_WIDTH**: `number` -Defined in: [src/shapes/Text/Text.ts:398](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L398) +Defined in: [src/shapes/Text/Text.ts:408](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L408) contains the min text width to avoid getting 0 @@ -1422,7 +1422,7 @@ contains the min text width to avoid getting 0 > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -1442,7 +1442,7 @@ Minimum allowed scale value of an object > **minWidth**: `number` -Defined in: [src/shapes/Textbox.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L67) +Defined in: [src/shapes/Textbox.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L67) Minimum width of textbox, in pixels. @@ -1456,7 +1456,7 @@ Minimum width of textbox, in pixels. > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -1476,11 +1476,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1500,7 +1500,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1526,7 +1526,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1543,7 +1543,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1563,7 +1563,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1579,7 +1579,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1595,7 +1595,7 @@ please use 'center' as value in new projects > **overline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L211) +Defined in: [src/shapes/Text/Text.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L213) Text decoration overline. @@ -1609,7 +1609,7 @@ Text decoration overline. > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1623,7 +1623,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1643,7 +1643,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1657,7 +1657,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1672,7 +1672,7 @@ Used to keep the original parent ref when the object has been added to an Active > `optional` **path**: [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Text/Text.ts:299](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L299) +Defined in: [src/shapes/Text/Text.ts:301](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L301) Path that the text should follow. since 4.6.0 the path will be drawn automatically. @@ -1707,7 +1707,7 @@ const textPath = new Text('Text on a path', { > **pathAlign**: [`TPathAlign`](/api/type-aliases/tpathalign/) -Defined in: [src/shapes/Text/Text.ts:335](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L335) +Defined in: [src/shapes/Text/Text.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L345) How text is aligned to the path. This property determines the perpendicular position of each character relative to the path. @@ -1724,7 +1724,7 @@ This feature is in BETA, and its behavior may change > **pathSide**: [`TPathSide`](/api/type-aliases/tpathside/) -Defined in: [src/shapes/Text/Text.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L326) +Defined in: [src/shapes/Text/Text.ts:336](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L336) Which side of the path the text should be drawn on. Only used when text has a path @@ -1739,7 +1739,7 @@ Only used when text has a path > **pathStartOffset**: `number` -Defined in: [src/shapes/Text/Text.ts:319](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L319) +Defined in: [src/shapes/Text/Text.ts:329](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L329) Offset amount for text path starting position Only used when text has a path @@ -1754,7 +1754,7 @@ Only used when text has a path > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1768,7 +1768,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1788,7 +1788,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1808,7 +1808,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1823,7 +1823,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1842,7 +1842,7 @@ This API is no longer supported and may be removed in a future release. > **selectionColor**: `string` -Defined in: [src/shapes/IText/IText.ts:150](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L150) +Defined in: [src/shapes/IText/IText.ts:150](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L150) Color of text selection @@ -1856,7 +1856,7 @@ Color of text selection > **selectionEnd**: `number` -Defined in: [src/shapes/IText/IText.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L140) +Defined in: [src/shapes/IText/IText.ts:140](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L140) Index where text selection ends @@ -1870,7 +1870,7 @@ Index where text selection ends > **selectionStart**: `number` -Defined in: [src/shapes/IText/IText.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L134) +Defined in: [src/shapes/IText/IText.ts:134](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L134) Index where text selection starts (or where cursor is when there is no selection) @@ -1884,7 +1884,7 @@ Index where text selection starts (or where cursor is when there is no selection > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) #### Inherited from @@ -1896,7 +1896,7 @@ Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1916,7 +1916,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1936,7 +1936,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1950,7 +1950,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1965,7 +1965,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **splitByGrapheme**: `boolean` -Defined in: [src/shapes/Textbox.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L83) +Defined in: [src/shapes/Textbox.ts:83](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L83) Use this boolean property in order to split strings that have no white space concept. this is a cheap way to help with chinese/japanese @@ -1984,7 +1984,7 @@ this is a cheap way to help with chinese/japanese > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) #### Inherited from @@ -1996,7 +1996,7 @@ Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -2016,7 +2016,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -2036,7 +2036,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -2056,7 +2056,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -2070,7 +2070,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -2090,7 +2090,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -2123,7 +2123,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -2143,7 +2143,7 @@ Width of a stroke used to render this object > **styles**: [`TextStyle`](/api/type-aliases/textstyle/) -Defined in: [src/shapes/Text/Text.ts:276](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L276) +Defined in: [src/shapes/Text/Text.ts:278](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L278) #### Inherited from @@ -2155,7 +2155,7 @@ Defined in: [src/shapes/Text/Text.ts:276](https://github.com/fabricjs/fabric.js/ > **subscript**: `object` -Defined in: [src/shapes/Text/Text.ts:257](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L257) +Defined in: [src/shapes/Text/Text.ts:259](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L259) Subscript schema object (minimum overlap) @@ -2193,7 +2193,7 @@ fontSize factor > **superscript**: `object` -Defined in: [src/shapes/Text/Text.ts:241](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L241) +Defined in: [src/shapes/Text/Text.ts:243](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L243) Superscript schema object (minimum overlap) @@ -2231,7 +2231,7 @@ fontSize factor > **text**: `string` -Defined in: [src/shapes/Text/Text.ts:181](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L181) +Defined in: [src/shapes/Text/Text.ts:183](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L183) #### Inherited from @@ -2243,7 +2243,7 @@ Defined in: [src/shapes/Text/Text.ts:181](https://github.com/fabricjs/fabric.js/ > **textAlign**: `TextAlign` -Defined in: [src/shapes/Text/Text.ts:224](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L224) +Defined in: [src/shapes/Text/Text.ts:226](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L226) Text alignment. Possible values: "left", "center", "right", "justify", "justify-left", "justify-center" or "justify-right". @@ -2258,7 +2258,7 @@ Text alignment. Possible values: "left", "center", "right", "justify", > **textBackgroundColor**: `string` -Defined in: [src/shapes/Text/Text.ts:274](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L274) +Defined in: [src/shapes/Text/Text.ts:276](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L276) Background color of text lines @@ -2268,17 +2268,34 @@ Background color of text lines *** +### textDecorationColor? + +> `optional` **textDecorationColor**: `string` + +Defined in: [src/shapes/Text/Text.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L323) + +Optional text decoration color for underline, overline and strikethrough. +When undefined, decoration color falls back to the text fill color. +This feature is not really supported by anything else than svg 2 specs with css3 support. +Chrome does not support this, nor firefox apparently. + +#### Inherited from + +[`IText`](/api/classes/itext/).[`textDecorationColor`](/api/classes/itext/#textdecorationcolor) + +*** + ### textDecorationThickness > **textDecorationThickness**: `number` -Defined in: [src/shapes/Text/Text.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L313) +Defined in: [src/shapes/Text/Text.ts:315](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L315) -The text decoration tickness for underline, overline and strikethrough -The tickness is expressed in thousandths of fontSize ( em ). +The text decoration thickness for underline, overline and strikethrough +The thickness is expressed in thousandths of fontSize ( em ). The original value was 1/15 that translates to 66.6667 thousandths. The choice of unit of measure is to align with charSpacing. -You can slim the tickness without issues, while large underline or overline may end up +You can slim the thickness without issues, while large underline or overline may end up outside the bounding box of the text. In order to fix that a bigger refactor of the code is needed and is out of scope for now. If you need such large overline on the first line of text or large underline on the last line of text, consider disabling caching as a @@ -2300,7 +2317,7 @@ workaround > **textLines**: `string`[] -Defined in: [src/shapes/Text/Text.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L405) +Defined in: [src/shapes/Text/Text.ts:415](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L415) contains the the text of the object, divided in lines as they are displayed on screen. Wrapping will divide the text independently of line breaks @@ -2315,7 +2332,7 @@ on screen. Wrapping will divide the text independently of line breaks > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -2337,7 +2354,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -2357,7 +2374,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -2377,7 +2394,7 @@ true > **underline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:205](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L205) +Defined in: [src/shapes/Text/Text.ts:207](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L207) Text decoration underline. @@ -2391,7 +2408,7 @@ Text decoration underline. > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -2405,7 +2422,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -2419,7 +2436,7 @@ Object width > `static` **\_styleProperties**: readonly `StylePropertiesType`[] = `styleProperties` -Defined in: [src/shapes/Text/StyledText.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L30) +Defined in: [src/shapes/Text/StyledText.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L30) #### Inherited from @@ -2431,7 +2448,7 @@ Defined in: [src/shapes/Text/StyledText.ts:30](https://github.com/fabricjs/fabri > `static` **ATTRIBUTE\_NAMES**: `string`[] -Defined in: [src/shapes/Text/Text.ts:1840](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1840) +Defined in: [src/shapes/Text/Text.ts:1857](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1857) List of attribute names to account for when parsing SVG element (used by [FabricText.fromElement](/api/classes/fabrictext/#fromelement)) @see: http://www.w3.org/TR/SVG/text.html#TextElement @@ -2446,7 +2463,7 @@ List of attribute names to account for when parsing SVG element (used by [Fabric > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Text/Text.ts:420](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L420) +Defined in: [src/shapes/Text/Text.ts:430](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L430) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -2463,7 +2480,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -2477,7 +2494,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -2492,7 +2509,7 @@ instance.toObject() gets called > `static` **genericFonts**: `string`[] -Defined in: [src/shapes/Text/Text.ts:1818](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1818) +Defined in: [src/shapes/Text/Text.ts:1835](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1835) List of generic font families @@ -2510,7 +2527,7 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#generic-name > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`Textbox`\<`Partial`\<[`TextboxProps`](/api/interfaces/textboxprops/)\>, [`SerializedTextboxProps`](/api/interfaces/serializedtextboxprops/), [`ITextEvents`](/api/type-aliases/itextevents/)\>\>\> = `textboxDefaultValues` -Defined in: [src/shapes/Textbox.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L95) +Defined in: [src/shapes/Textbox.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L95) #### Overrides @@ -2522,7 +2539,7 @@ Defined in: [src/shapes/Textbox.ts:95](https://github.com/fabricjs/fabric.js/blo > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -2538,7 +2555,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Textbox'` -Defined in: [src/shapes/Textbox.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L91) +Defined in: [src/shapes/Textbox.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L91) #### Overrides @@ -2552,7 +2569,7 @@ Defined in: [src/shapes/Textbox.ts:91](https://github.com/fabricjs/fabric.js/blo > **get** **type**(): `string` -Defined in: [src/shapes/IText/IText.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L213) +Defined in: [src/shapes/IText/IText.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L213) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -2581,7 +2598,7 @@ This API is no longer supported and may be removed in a future release. > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -2613,7 +2630,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_getFontDeclaration**(`__namedParameters?`, `forMeasuring?`): `string` -Defined in: [src/shapes/Text/Text.ts:1677](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1677) +Defined in: [src/shapes/Text/Text.ts:1694](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1694) return font declaration string for canvas context @@ -2643,7 +2660,7 @@ font declaration formatted for canvas context. > **\_getGraphemeBox**(`grapheme`, `lineIndex`, `charIndex`, `prevGrapheme?`, `skipLeft?`): [`GraphemeBBox`](/api/type-aliases/graphemebbox/) -Defined in: [src/shapes/Text/Text.ts:979](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L979) +Defined in: [src/shapes/Text/Text.ts:989](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L989) #### Parameters @@ -2691,7 +2708,7 @@ grapheme bbox > **\_getSelectionForOffset**(`e`, `isRight`): `number` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:383](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L383) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L383) private Helps finding if the offset should be counted from Start or End @@ -2722,7 +2739,7 @@ Event object > **\_getWidthOfCharSpacing**(): `number` -Defined in: [src/shapes/Text/Text.ts:1526](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1526) +Defined in: [src/shapes/Text/Text.ts:1536](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1536) #### Returns @@ -2738,7 +2755,7 @@ Defined in: [src/shapes/Text/Text.ts:1526](https://github.com/fabricjs/fabric.js > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -2768,7 +2785,7 @@ dims > **\_measureLine**(`lineIndex`): `object` -Defined in: [src/shapes/Text/Text.ts:887](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L887) +Defined in: [src/shapes/Text/Text.ts:897](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L897) measure every grapheme of a line, populating __charBounds @@ -2802,7 +2819,7 @@ object.width total width of characters > **\_measureWord**(`word`, `lineIndex`, `charOffset`): `number` -Defined in: [src/shapes/Textbox.ts:387](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L387) +Defined in: [src/shapes/Textbox.ts:387](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L387) Helper function to measure a string of text, given its lineIndex and charIndex offset It gets called when charBounds are not available yet. @@ -2833,7 +2850,7 @@ Use with [Textbox#wordSplit](/api/classes/textbox/#wordsplit) > **\_mouseDownHandler**(`__namedParameters`): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L98) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L98) Default event handler for the basic functionalities needed on _mouseDown can be overridden to do something different. @@ -2862,7 +2879,7 @@ current compositionMode. It will be set to false. > **\_moveCursorLeftOrRight**(`direction`, `e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:645](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L645) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:645](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L645) Moves cursor right or Left, fires event @@ -2894,7 +2911,7 @@ Event object > **\_moveCursorUpOrDown**(`direction`, `e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L483) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L483) Moves cursor up or down, fires the events @@ -2926,7 +2943,7 @@ Event object > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -2944,7 +2961,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -2981,7 +2998,7 @@ move to interactivity > **\_renderCursor**(`ctx`, `boundaries`, `selectionStart`): `void` -Defined in: [src/shapes/IText/IText.ts:601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L601) +Defined in: [src/shapes/IText/IText.ts:601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L601) Render the cursor at the given selectionStart. @@ -3015,7 +3032,7 @@ transformed context to draw on > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -3037,7 +3054,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `style`): `object` -Defined in: [src/shapes/Text/Text.ts:1343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1343) +Defined in: [src/shapes/Text/Text.ts:1353](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1353) This function prepare the canvas for a ill style, and fill need to be sent in as defined @@ -3076,7 +3093,7 @@ with ill defined > **\_setStrokeStyles**(`ctx`, `style`): `object` -Defined in: [src/shapes/Text/Text.ts:1321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1321) +Defined in: [src/shapes/Text/Text.ts:1331](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1331) This function prepare the canvas for a stroke style, and stroke and strokeWidth need to be sent in as defined @@ -3115,7 +3132,7 @@ with stroke and strokeWidth defined > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -3142,7 +3159,7 @@ Rendering canvas context > **\_splitTextIntoLines**(`text`): `TextLinesInfo` -Defined in: [src/shapes/Textbox.ts:531](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L531) +Defined in: [src/shapes/Textbox.ts:530](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L530) Gets lines of text to render in the Textbox. This function calculates text wrapping on the fly every time it is called. @@ -3171,7 +3188,7 @@ Array of lines in the Textbox. > **\_toSVG**(`_reviver?`): `string`[] -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:126](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L126) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L136) Returns svg representation of an instance This function is implemented in each subclass @@ -3200,7 +3217,7 @@ of the instance > **\_wrapText**(`lines`, `desiredWidth`): `string`[][] -Defined in: [src/shapes/Textbox.ts:322](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L322) +Defined in: [src/shapes/Textbox.ts:322](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L322) Wraps text using the 'width' property of Textbox. First this function splits text on newlines, so we preserve newlines entered by the user. @@ -3233,7 +3250,7 @@ Array of lines > **abortCursorAnimation**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:183](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L183) +Defined in: [src/shapes/IText/ITextBehavior.ts:183](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L183) Aborts cursor animation, clears all timeouts and clear textarea context if necessary @@ -3251,7 +3268,7 @@ Aborts cursor animation, clears all timeouts and clear textarea context if neces > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -3273,7 +3290,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -3320,7 +3337,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **blur**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L106) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L106) Override this method to customize cursor behavior on textbox blur @@ -3338,7 +3355,7 @@ Override this method to customize cursor behavior on textbox blur > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -3357,7 +3374,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -3378,7 +3395,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -3399,7 +3416,7 @@ transform matrix for the object > **calcTextHeight**(): `number` -Defined in: [src/shapes/Text/Text.ts:1051](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1051) +Defined in: [src/shapes/Text/Text.ts:1061](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1061) Calculate text box height @@ -3417,7 +3434,7 @@ Calculate text box height > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -3447,7 +3464,7 @@ transform matrix for the object > **canDrop**(`e`): `boolean` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L64) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L64) override this method to control whether instance should/shouldn't become a drop target @@ -3471,7 +3488,7 @@ override this method to control whether instance should/shouldn't become a drop > **cleanStyle**(`property`): `undefined` \| `false` -Defined in: [src/shapes/Text/StyledText.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L98) +Defined in: [src/shapes/Text/StyledText.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L98) Check if characters in a text have a value for a property whose value matches the textbox's value for that property. If so, @@ -3500,7 +3517,7 @@ then it also is deleted. > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -3536,7 +3553,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Textbox`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -3562,7 +3579,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -3599,7 +3616,7 @@ fix the export type, it could not be Image but the type that getClass return for > **cmdAll**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L230) +Defined in: [src/shapes/IText/ITextBehavior.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L230) Selects entire text and updates the visual state @@ -3617,7 +3634,7 @@ Selects entire text and updates the visual state > **complexity**(): `number` -Defined in: [src/shapes/Text/Text.ts:1810](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1810) +Defined in: [src/shapes/Text/Text.ts:1827](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1827) Returns complexity of an instance @@ -3637,7 +3654,7 @@ complexity > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -3665,7 +3682,7 @@ true if point is inside the object > **copy**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:301](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L301) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:301](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L301) Copies selected text @@ -3683,7 +3700,7 @@ Copies selected text > **dispose**(): `void` -Defined in: [src/shapes/IText/IText.ts:771](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L771) +Defined in: [src/shapes/IText/IText.ts:770](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L770) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -3702,7 +3719,7 @@ override if necessary to dispose artifacts such as `clipPath` > **doubleClickHandler**(`options`): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L71) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L71) Default handler for double click, select a word @@ -3726,7 +3743,7 @@ Default handler for double click, select a word > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -3766,7 +3783,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -3796,7 +3813,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -3830,7 +3847,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -3867,7 +3884,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -3901,7 +3918,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -3939,7 +3956,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -3974,7 +3991,7 @@ it seemed a good option, now is an edge case > **enlargeSpaces**(): `void` -Defined in: [src/shapes/Text/Text.ts:496](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L496) +Defined in: [src/shapes/Text/Text.ts:506](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L506) Enlarge space boxes and shift the others @@ -3992,7 +4009,7 @@ Enlarge space boxes and shift the others > **enterEditing**(`e?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:392](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L392) +Defined in: [src/shapes/IText/ITextBehavior.ts:392](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L392) Enters editing state @@ -4016,7 +4033,7 @@ Enters editing state > **enterEditingImpl**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:411](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L411) +Defined in: [src/shapes/IText/ITextBehavior.ts:411](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L411) runs the actual logic that enter from editing state, see [enterEditing](/api/classes/textbox/#enterediting) @@ -4034,7 +4051,7 @@ runs the actual logic that enter from editing state, see [enterEditing](/api/cla > **exitEditing**(): `Textbox`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/IText/ITextBehavior.ts:726](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L726) +Defined in: [src/shapes/IText/ITextBehavior.ts:726](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L726) Exits from editing state and fires relevant events @@ -4052,7 +4069,7 @@ Exits from editing state and fires relevant events > **exitEditingImpl**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:702](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L702) +Defined in: [src/shapes/IText/ITextBehavior.ts:702](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L702) runs the actual logic that exits from editing state, see [exitEditing](/api/classes/textbox/#exitediting) But it does not fire events @@ -4071,7 +4088,7 @@ But it does not fire events > **findAncestorsWithClipPath**(): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/shapes/IText/IText.ts:440](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L440) +Defined in: [src/shapes/IText/IText.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L440) Finds and returns an array of clip paths that are applied to the parent group(s) of the current FabricObject instance. The object's hierarchy is @@ -4093,7 +4110,7 @@ absolutely positioned. > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -4125,7 +4142,7 @@ an object that represent the ancestry situation. > **findLineBoundaryLeft**(`startFrom`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:296](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L296) +Defined in: [src/shapes/IText/ITextBehavior.ts:296](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L296) Find new selection index representing start of current line according to current selection index @@ -4153,7 +4170,7 @@ New selection index > **findLineBoundaryRight**(`startFrom`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L313) +Defined in: [src/shapes/IText/ITextBehavior.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L313) Find new selection index representing end of current line according to current selection index @@ -4181,7 +4198,7 @@ New selection index > **findWordBoundaryLeft**(`startFrom`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:248](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L248) +Defined in: [src/shapes/IText/ITextBehavior.ts:248](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L248) Find new selection index representing start of current word according to current selection index @@ -4209,7 +4226,7 @@ New selection index > **findWordBoundaryRight**(`startFrom`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:272](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L272) +Defined in: [src/shapes/IText/ITextBehavior.ts:272](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L272) Find new selection index representing end of current word according to current selection index @@ -4237,7 +4254,7 @@ New selection index > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -4275,7 +4292,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -4302,7 +4319,7 @@ function to iterate over the controls over > **fromGraphemeToStringSelection**(`start`, `end`, `graphemes`): `object` -Defined in: [src/shapes/IText/ITextBehavior.ts:504](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L504) +Defined in: [src/shapes/IText/ITextBehavior.ts:504](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L504) convert from fabric to textarea values @@ -4342,7 +4359,7 @@ convert from fabric to textarea values > **fromStringToGraphemeSelection**(`start`, `end`, `text`): `object` -Defined in: [src/shapes/IText/ITextBehavior.ts:487](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L487) +Defined in: [src/shapes/IText/ITextBehavior.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L487) convert from textarea to grapheme indexes @@ -4382,7 +4399,7 @@ convert from textarea to grapheme indexes > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -4410,7 +4427,7 @@ value of a property > **get2DCursorLocation**(`selectionStart?`, `skipWrapping?`): `object` -Defined in: [src/shapes/IText/IText.ts:339](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L339) +Defined in: [src/shapes/IText/IText.ts:339](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L339) Returns 2d representation (lineIndex and charIndex) of cursor (or selection start) @@ -4450,7 +4467,7 @@ consider the location for unwrapped lines. useful to manage styles. > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -4466,7 +4483,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -4484,7 +4501,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -4505,7 +4522,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -4521,7 +4538,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -4539,7 +4556,7 @@ Returns the center coordinates of the object relative to canvas > **getCompleteStyleDeclaration**(`lineIndex`, `charIndex`): [`CompleteTextStyleDeclaration`](/api/type-aliases/completetextstyledeclaration/) -Defined in: [src/shapes/Text/StyledText.ts:273](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L273) +Defined in: [src/shapes/Text/StyledText.ts:273](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L273) return a new object that contains all the style property for a character the object returned is newly created @@ -4574,7 +4591,7 @@ style object > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -4592,7 +4609,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getCurrentCharColor**(): `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/IText/IText.ts:755](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L755) +Defined in: [src/shapes/IText/IText.ts:754](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L754) High level function to know the color of the cursor. the currentChar is the one that precedes the cursor @@ -4616,7 +4633,7 @@ Character color (fill) > **getCurrentCharFontSize**(): `number` -Defined in: [src/shapes/IText/IText.ts:742](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L742) +Defined in: [src/shapes/IText/IText.ts:741](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L741) High level function to know the height of the cursor. the currentChar is the one that precedes the cursor @@ -4639,7 +4656,7 @@ Character font size > **getCursorRenderingData**(`selectionStart`, `boundaries`): [`CursorRenderingData`](/api/type-aliases/cursorrenderingdata/) -Defined in: [src/shapes/IText/IText.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L567) +Defined in: [src/shapes/IText/IText.ts:567](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L567) Return the data needed to render the cursor for given selection start The left,top are relative to the object, while width and height are prescaled @@ -4670,7 +4687,7 @@ so they depend on canvas and object scaling > **getDownCursorOffset**(`e`, `isRight`): `number` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:351](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L351) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:351](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L351) Gets start offset of a selection @@ -4700,7 +4717,7 @@ Event object > **getGraphemeDataForRender**(`lines`): [`GraphemeData`](/api/type-aliases/graphemedata/) -Defined in: [src/shapes/Textbox.ts:341](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L341) +Defined in: [src/shapes/Textbox.ts:341](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L341) For each line of text terminated by an hard line stop, measure each word width and extract the largest word from all. @@ -4724,7 +4741,7 @@ the lines we need to measure > **getHeightOfChar**(`line`, `_char`): `number` -Defined in: [src/shapes/Text/Text.ts:862](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L862) +Defined in: [src/shapes/Text/Text.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L872) Computes height of character at given position @@ -4758,7 +4775,7 @@ fontSize of the character > **getHeightOfLine**(`lineIndex`): `number` -Defined in: [src/shapes/Text/Text.ts:1044](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1044) +Defined in: [src/shapes/Text/Text.ts:1054](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1054) Calculate height of line at 'lineIndex' @@ -4784,7 +4801,7 @@ index of line to calculate > **getMinWidth**(): `number` -Defined in: [src/shapes/Textbox.ts:543](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L543) +Defined in: [src/shapes/Textbox.ts:542](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L542) #### Returns @@ -4796,7 +4813,7 @@ Defined in: [src/shapes/Textbox.ts:543](https://github.com/fabricjs/fabric.js/bl > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -4814,7 +4831,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -4832,7 +4849,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/textbox/#getpositionbyorigin) @@ -4864,7 +4881,7 @@ use [getPositionByOrigin](/api/classes/textbox/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/textbox/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -4902,7 +4919,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -4920,7 +4937,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -4939,7 +4956,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/textb > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -4957,7 +4974,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -4976,7 +4993,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/textb > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -5000,7 +5017,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -5024,7 +5041,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSelectedText**(): `string` -Defined in: [src/shapes/IText/ITextBehavior.ts:239](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L239) +Defined in: [src/shapes/IText/ITextBehavior.ts:239](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L239) Returns selected text @@ -5042,7 +5059,7 @@ Returns selected text > **getSelectionStartFromPointer**(`e`): `number` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L193) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L193) Returns index of a character corresponding to where an object was clicked @@ -5070,7 +5087,7 @@ Index of a character > **getSelectionStyles**(`startIndex`, `endIndex`, `complete?`): `Partial`\<[`CompleteTextStyleDeclaration`](/api/type-aliases/completetextstyledeclaration/)\>[] -Defined in: [src/shapes/IText/IText.ts:312](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L312) +Defined in: [src/shapes/IText/IText.ts:312](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L312) Gets style of a current selection/cursor (at the start position) if startIndex or endIndex are not provided, selectionStart or selectionEnd will be used. @@ -5111,7 +5128,7 @@ styles an array with one, zero or more Style objects > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -5135,7 +5152,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -5159,7 +5176,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -5189,7 +5206,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -5221,7 +5238,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -5239,7 +5256,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -5259,7 +5276,7 @@ object with scaleX and scaleY properties > **getUpCursorOffset**(`e`, `isRight`): `number` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L396) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L396) #### Parameters @@ -5287,7 +5304,7 @@ Event object > **getValueOfPropertyAt**\<`T`\>(`lineIndex`, `charIndex`, `property`): `Textbox`\<`Props`, `SProps`, `EventSpec`\>\[`T`\] -Defined in: [src/shapes/Text/Text.ts:1540](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1540) +Defined in: [src/shapes/Text/Text.ts:1550](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1550) Retrieves the value of property at given character position @@ -5333,7 +5350,7 @@ the value of 'property' > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -5351,7 +5368,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -5369,7 +5386,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -5387,7 +5404,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -5405,7 +5422,7 @@ y position according to object's originY property in canvas coordinate plane > **graphemeSplit**(`value`): `string`[] -Defined in: [src/shapes/Text/Text.ts:1736](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1736) +Defined in: [src/shapes/Text/Text.ts:1753](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1753) Override this method to customize grapheme splitting @@ -5437,7 +5454,7 @@ in the middle of the prototype chain > **handleFiller**\<`T`\>(`ctx`, `property`, `filler`): `object` -Defined in: [src/shapes/Text/Text.ts:1281](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1281) +Defined in: [src/shapes/Text/Text.ts:1291](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1291) #### Type Parameters @@ -5481,7 +5498,7 @@ Defined in: [src/shapes/Text/Text.ts:1281](https://github.com/fabricjs/fabric.js > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -5509,7 +5526,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -5538,7 +5555,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -5567,7 +5584,7 @@ Boolean > **initBehavior**(): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L26) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L26) Initializes all the interactive behavior of IText @@ -5585,7 +5602,7 @@ Initializes all the interactive behavior of IText > **initDelayedCursor**(`restart?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:175](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L175) +Defined in: [src/shapes/IText/ITextBehavior.ts:175](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L175) Initializes delayed cursor @@ -5609,7 +5626,7 @@ Initializes delayed cursor > **initHiddenTextarea**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L62) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L62) Initializes hidden textarea (needed to bring up keyboard in iOS) @@ -5627,7 +5644,7 @@ Initializes hidden textarea (needed to bring up keyboard in iOS) > **insertChars**(`text`, `style`, `start`, `end`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:1062](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L1062) +Defined in: [src/shapes/IText/ITextBehavior.ts:1062](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L1062) insert characters at start position, before start position. start equal 1 it means the text get inserted between actual grapheme 0 and 1 @@ -5673,7 +5690,7 @@ default to start + 1 > **insertCharStyleObject**(`lineIndex`, `charIndex`, `quantity`, `copiedStyle?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:912](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L912) +Defined in: [src/shapes/IText/ITextBehavior.ts:912](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L912) Inserts style object for a given line/char index @@ -5717,7 +5734,7 @@ array of style objects > **insertNewlineStyleObject**(`lineIndex`, `charIndex`, `qty`, `copiedStyle?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:843](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L843) +Defined in: [src/shapes/IText/ITextBehavior.ts:843](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L843) Handle insertion of more consecutive style lines for when one or more newlines gets added to the text. Since current style needs to be shifted @@ -5762,7 +5779,7 @@ Array of objects styles > **insertNewStyleBlock**(`insertedText`, `start`, `copiedStyle?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:970](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L970) +Defined in: [src/shapes/IText/ITextBehavior.ts:970](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L970) Inserts style object(s) @@ -5800,7 +5817,7 @@ array of style objects to insert. > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -5828,7 +5845,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -5856,7 +5873,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -5886,7 +5903,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -5914,7 +5931,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -5942,7 +5959,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -5971,7 +5988,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -5996,7 +6013,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isEmptyStyles**(`lineIndex`): `boolean` -Defined in: [src/shapes/Textbox.ts:207](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L207) +Defined in: [src/shapes/Textbox.ts:207](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L207) Returns true if object has no styling or no styling in a line @@ -6022,7 +6039,7 @@ Returns true if object has no styling or no styling in a line > **isEndOfWrapping**(`lineIndex`): `boolean` -Defined in: [src/shapes/Textbox.ts:498](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L498) +Defined in: [src/shapes/Textbox.ts:497](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L497) Detect if the text line is ended with an hard break text and itext do not have wrapping, return false @@ -6049,7 +6066,7 @@ text to split > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -6081,7 +6098,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -6099,7 +6116,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -6120,7 +6137,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -6148,7 +6165,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -6168,7 +6185,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -6204,7 +6221,7 @@ A list of type strings to check against. > **measureLine**(`lineIndex`): `object` -Defined in: [src/shapes/Text/Text.ts:870](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L870) +Defined in: [src/shapes/Text/Text.ts:880](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L880) measure a text line measuring all characters. @@ -6238,7 +6255,7 @@ line number > **missingNewlineOffset**(`lineIndex`, `skipWrapping?`): `0` \| `1` -Defined in: [src/shapes/Textbox.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L517) +Defined in: [src/shapes/Textbox.ts:516](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L516) Detect if a line has a linebreak and so we need to account for it when moving and counting style. @@ -6271,7 +6288,7 @@ Number > **moveCursorDown**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:457](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L457) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:457](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L457) Moves cursor down @@ -6297,7 +6314,7 @@ Event object > **moveCursorLeft**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:542](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L542) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:542](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L542) Moves cursor left @@ -6323,7 +6340,7 @@ Event object > **moveCursorLeftWithoutShift**(`e`): `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:594](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L594) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L594) Moves cursor left without keeping selection @@ -6347,7 +6364,7 @@ Moves cursor left without keeping selection > **moveCursorLeftWithShift**(`e`): `undefined` \| `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:614](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L614) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:614](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L614) Moves cursor left while keeping selection @@ -6371,7 +6388,7 @@ Moves cursor left while keeping selection > **moveCursorRight**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:630](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L630) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:630](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L630) Moves cursor right @@ -6397,7 +6414,7 @@ Event object > **moveCursorRightWithoutShift**(`e`): `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:680](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L680) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:680](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L680) Moves cursor right without keeping selection @@ -6423,7 +6440,7 @@ Event object > **moveCursorRightWithShift**(`e`): `undefined` \| `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:664](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L664) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:664](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L664) Moves cursor right while keeping selection @@ -6447,7 +6464,7 @@ Moves cursor right while keeping selection > **moveCursorUp**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:471](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L471) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:471](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L471) Moves cursor up @@ -6473,7 +6490,7 @@ Event object > **moveCursorWithoutShift**(`offset`): `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:527](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L527) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L527) Moves cursor up without shift @@ -6497,7 +6514,7 @@ Moves cursor up without shift > **moveCursorWithShift**(`offset`): `boolean` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:510](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L510) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:510](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L510) Moves cursor with shift @@ -6521,7 +6538,7 @@ Moves cursor with shift > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -6547,7 +6564,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -6583,7 +6600,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -6619,7 +6636,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -6643,7 +6660,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -6663,7 +6680,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -6709,7 +6726,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -6743,7 +6760,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -6789,7 +6806,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -6821,7 +6838,7 @@ once > **onCompositionEnd**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:287](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L287) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:287](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L287) Composition end @@ -6839,7 +6856,7 @@ Composition end > **onCompositionStart**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:280](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L280) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:280](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L280) Composition start @@ -6857,7 +6874,7 @@ Composition start > **onCompositionUpdate**(`__namedParameters`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L291) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:291](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L291) #### Parameters @@ -6879,7 +6896,7 @@ Defined in: [src/shapes/IText/ITextKeyBehavior.ts:291](https://github.com/fabric > **onDeselect**(`options?`): `boolean` -Defined in: [src/shapes/IText/ITextBehavior.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L111) +Defined in: [src/shapes/IText/ITextBehavior.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L111) 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 @@ -6915,7 +6932,7 @@ this is being deselected > **onDragStart**(`e`): `boolean` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L57) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L57) override this method to control whether instance should/shouldn't become a drag source, @@ -6946,7 +6963,7 @@ To prevent drag and drop between objects both shouldStartDragging and onDragStar > **onInput**(`this`, `e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:174](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L174) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:174](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L174) Handles onInput event @@ -6976,7 +6993,7 @@ Event object > **onKeyDown**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L115) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L115) Handles keydown event only used for arrows and combination of modifier keys. @@ -7003,7 +7020,7 @@ Event object > **onKeyUp**(`e`): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L151) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L151) Handles keyup event We handle KeyUp because ie11 and edge have difficulties copy/pasting @@ -7031,7 +7048,7 @@ Event object > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -7062,7 +7079,7 @@ event if the process is generated by an event > **paste**(): `void` -Defined in: [src/shapes/IText/ITextKeyBehavior.ts:323](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextKeyBehavior.ts#L323) +Defined in: [src/shapes/IText/ITextKeyBehavior.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextKeyBehavior.ts#L323) Pastes text @@ -7080,7 +7097,7 @@ Pastes text > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -7106,7 +7123,7 @@ Places the left/top corner of the object bounding box in p. > **removeChars**(`start`, `end`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:1040](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L1040) +Defined in: [src/shapes/IText/ITextBehavior.ts:1040](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L1040) Removes characters from start/end start/end ar per grapheme position in _text array. @@ -7137,7 +7154,7 @@ default to start + 1 > **removeStyle**(`property`): `void` -Defined in: [src/shapes/Text/StyledText.ts:159](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L159) +Defined in: [src/shapes/Text/StyledText.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L159) Remove a style property or properties from all individual character styles in a text object. Deletes the character style object if it contains no other style @@ -7163,7 +7180,7 @@ props. Deletes a line style object if it contains no other character styles. > **removeStyleFromTo**(`start`, `end`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:758](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L758) +Defined in: [src/shapes/IText/ITextBehavior.ts:758](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L758) remove and reflow a style block from start to end. @@ -7195,7 +7212,7 @@ linear end position for removal ( excluded from removal ) > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -7221,7 +7238,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderCursor**(`ctx`, `boundaries`): `void` -Defined in: [src/shapes/IText/IText.ts:557](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L557) +Defined in: [src/shapes/IText/IText.ts:557](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L557) Renders cursor @@ -7251,7 +7268,7 @@ transformed context to draw on > **renderCursorAt**(`selectionStart`): `void` -Defined in: [src/shapes/IText/IText.ts:544](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L544) +Defined in: [src/shapes/IText/IText.ts:544](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L544) Renders cursor on context Top, outside the animation cycle, on request Used for the drag/drop effect. @@ -7277,7 +7294,7 @@ If contextTop is not available, do nothing. > **renderCursorOrSelection**(): `void` -Defined in: [src/shapes/IText/IText.ts:374](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L374) +Defined in: [src/shapes/IText/IText.ts:374](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L374) Renders cursor or selection (depending on what exists) it does on the contextTop. If contextTop is not available, do nothing. @@ -7296,7 +7313,7 @@ it does on the contextTop. If contextTop is not available, do nothing. > **renderDragSourceEffect**(): `void` -Defined in: [src/shapes/IText/IText.ts:633](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L633) +Defined in: [src/shapes/IText/IText.ts:633](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L633) Renders drag start text selection @@ -7314,7 +7331,7 @@ Renders drag start text selection > **renderDropTargetEffect**(`e`): `void` -Defined in: [src/shapes/IText/IText.ts:643](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L643) +Defined in: [src/shapes/IText/IText.ts:643](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L643) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -7341,7 +7358,7 @@ object will change when dropping. example: show the cursor where the text is abo > **renderSelection**(`ctx`, `boundaries`): `void` -Defined in: [src/shapes/IText/IText.ts:618](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L618) +Defined in: [src/shapes/IText/IText.ts:618](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L618) Renders text selection @@ -7373,7 +7390,7 @@ Object with left/top/leftOffset/topOffset > **restartCursorIfNeeded**(): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L206) +Defined in: [src/shapes/IText/ITextBehavior.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L206) Restart tue cursor animation if either is in complete state ( between animations ) or if it never started before @@ -7392,7 +7409,7 @@ or if it never started before > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -7418,7 +7435,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -7444,7 +7461,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -7470,7 +7487,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -7496,7 +7513,7 @@ New width value > **searchWordBoundary**(`selectionStart`, `direction`): `number` -Defined in: [src/shapes/IText/ITextBehavior.ts:331](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L331) +Defined in: [src/shapes/IText/ITextBehavior.ts:331](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L331) Finds index corresponding to beginning or end of a word @@ -7530,7 +7547,7 @@ Index of the beginning or end of a word > **selectAll**(): `Textbox`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/IText/ITextBehavior.ts:219](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L219) +Defined in: [src/shapes/IText/ITextBehavior.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L219) Selects entire text @@ -7548,7 +7565,7 @@ Selects entire text > **selectLine**(`selectionStart?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:378](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L378) +Defined in: [src/shapes/IText/ITextBehavior.ts:378](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L378) Selects the line that contains selectionStart @@ -7574,7 +7591,7 @@ Index of a character > **selectWord**(`selectionStart?`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:356](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L356) +Defined in: [src/shapes/IText/ITextBehavior.ts:356](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L356) Selects the word that contains the char at index selectionStart @@ -7600,7 +7617,7 @@ Index of a character > **set**(`key`, `value?`): `Textbox`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Text/Text.ts:1779](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1779) +Defined in: [src/shapes/Text/Text.ts:1796](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1796) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -7632,7 +7649,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -7659,7 +7676,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -7697,7 +7714,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -7716,7 +7733,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setCursorByClick**(`e`): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:172](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L172) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:172](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L172) Changes cursor location in a text depending on passed pointer (x/y) object @@ -7742,7 +7759,7 @@ Event object > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -7763,7 +7780,7 @@ Travis build error about unused variables. > **setPathInfo**(): `void` -Defined in: [src/shapes/Text/Text.ts:450](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L450) +Defined in: [src/shapes/Text/Text.ts:460](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L460) If text has a path, it will add the extra information needed for path and text calculations @@ -7782,7 +7799,7 @@ for path and text calculations > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -7820,7 +7837,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -7845,7 +7862,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/textbox > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/textbox/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -7883,7 +7900,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -7908,7 +7925,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/textb > **setSelectionEnd**(`index`): `void` -Defined in: [src/shapes/IText/IText.ts:262](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L262) +Defined in: [src/shapes/IText/IText.ts:262](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L262) Sets selection end (right boundary of a selection) @@ -7934,7 +7951,7 @@ Index to set selection end to > **setSelectionStart**(`index`): `void` -Defined in: [src/shapes/IText/IText.ts:253](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L253) +Defined in: [src/shapes/IText/IText.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L253) Sets selection start (left boundary of a selection) @@ -7960,7 +7977,7 @@ Index to set selection start to > **setSelectionStartEndWithShift**(`start`, `end`, `newSelection`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:1089](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L1089) +Defined in: [src/shapes/IText/ITextBehavior.ts:1089](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L1089) Set the selectionStart and selectionEnd according to the new position of cursor mimic the key - mouse navigation when shift is pressed. @@ -7993,7 +8010,7 @@ mimic the key - mouse navigation when shift is pressed. > **setSelectionStyles**(`styles?`, `startIndex?`, `endIndex?`): `void` -Defined in: [src/shapes/IText/IText.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L326) +Defined in: [src/shapes/IText/IText.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L326) Sets style of a current selection, if no selection exist, do not set anything. @@ -8031,7 +8048,7 @@ End index to get styles at, if not specified selectionEnd or startIndex + 1 > **setSubscript**(`start`, `end`): `void` -Defined in: [src/shapes/Text/Text.ts:1422](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1422) +Defined in: [src/shapes/Text/Text.ts:1432](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1432) Turns the character into an 'inferior figure' (i.e. 'subscript') @@ -8063,7 +8080,7 @@ selection end > **setSuperscript**(`start`, `end`): `void` -Defined in: [src/shapes/Text/Text.ts:1413](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1413) +Defined in: [src/shapes/Text/Text.ts:1423](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1423) Turns the character into a 'superior figure' (i.e. 'superscript') @@ -8095,7 +8112,7 @@ selection end > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -8119,7 +8136,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -8165,7 +8182,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -8189,7 +8206,7 @@ y position according to object's originY property in canvas coordinate plane > **shiftLineStyles**(`lineIndex`, `offset`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:820](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L820) +Defined in: [src/shapes/IText/ITextBehavior.ts:820](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L820) Shifts line styles up or down @@ -8221,7 +8238,7 @@ Can any number? > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -8244,7 +8261,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(): `boolean` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L47) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L47) If this method returns true a mouse move operation over a text selection will not prevent the native mouse event allowing the browser to start a drag operation. @@ -8265,7 +8282,7 @@ To prevent drag and drop between objects both shouldStartDragging and onDragStar > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -8297,7 +8314,7 @@ the control box size used > **styleHas**(`property`, `lineIndex`): `boolean` -Defined in: [src/shapes/Textbox.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L192) +Defined in: [src/shapes/Textbox.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L192) Returns true if object has a style property or has it on a specified line @@ -8325,7 +8342,7 @@ Returns true if object has a style property or has it on a specified line > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -8347,7 +8364,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options?`): `HTMLCanvasElement` -Defined in: [src/shapes/IText/IText.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L362) +Defined in: [src/shapes/IText/IText.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L362) block cursor/selection logic while rendering the exported canvas @@ -8375,7 +8392,7 @@ this workaround should be replaced with a more robust solution > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -8407,7 +8424,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -8435,7 +8452,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -8463,7 +8480,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Textbox`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -8489,7 +8506,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -8509,7 +8526,7 @@ JSON > **toObject**\<`T`, `K`\>(`propertiesToInclude?`): `Pick`\<`T`, `K`\> & `SProps` -Defined in: [src/shapes/Textbox.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L568) +Defined in: [src/shapes/Textbox.ts:567](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L567) Returns object representation of an instance @@ -8547,7 +8564,7 @@ object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Text/Text.ts:586](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L586) +Defined in: [src/shapes/Text/Text.ts:596](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L596) Returns string representation of an instance @@ -8567,7 +8584,7 @@ String representation of text object > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -8599,7 +8616,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -8625,7 +8642,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -8647,7 +8664,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -8685,7 +8702,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -8735,7 +8752,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -8773,7 +8790,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **tripleClickHandler**(`options`): `void` -Defined in: [src/shapes/IText/ITextClickBehavior.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextClickBehavior.ts#L82) +Defined in: [src/shapes/IText/ITextClickBehavior.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextClickBehavior.ts#L82) Default handler for triple click, select a line @@ -8797,7 +8814,7 @@ Default handler for triple click, select a line > **updateSelectionOnMouseMove**(`e`): `void` -Defined in: [src/shapes/IText/ITextBehavior.ts:433](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L433) +Defined in: [src/shapes/IText/ITextBehavior.ts:433](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L433) called by [Canvas#textEditingManager](/api/classes/canvas/#texteditingmanager) @@ -8821,7 +8838,7 @@ called by [Canvas#textEditingManager](/api/classes/canvas/#texteditingmanager) > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -8844,7 +8861,7 @@ This API is no longer supported and may be removed in a future release. > **wordSplit**(`value`): `string`[] -Defined in: [src/shapes/Textbox.ts:411](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L411) +Defined in: [src/shapes/Textbox.ts:411](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L411) Override this method to customize word splitting Use with [Textbox#\_measureWord](/api/classes/textbox/#_measureword) @@ -8867,7 +8884,7 @@ array of words > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -8899,7 +8916,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Textbox.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L118) +Defined in: [src/shapes/Textbox.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L118) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -8923,7 +8940,7 @@ make this function return an empty object and add controls to the ownDefaults ob > `static` **fromElement**(`element`, `options?`, `cssRules?`): `Promise`\<[`FabricText`](/api/classes/fabrictext/)\<\{ `fontSize`: `number`; `left`: `number`; `linethrough`: `boolean`; `overline`: `boolean`; `signal?`: `AbortSignal`; `strokeWidth`: `number`; `top`: `number`; `underline`: `boolean`; \}, [`SerializedTextProps`](/api/interfaces/serializedtextprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Text/Text.ts:1859](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1859) +Defined in: [src/shapes/Text/Text.ts:1878](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1878) Returns FabricText instance from an SVG element (not yet implemented) @@ -8959,7 +8976,7 @@ Options object > `static` **fromObject**\<`T`, `S`\>(`object`): `Promise`\<`S`\> -Defined in: [src/shapes/Text/Text.ts:1934](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L1934) +Defined in: [src/shapes/Text/Text.ts:1953](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L1953) Returns FabricText instance from an object representation @@ -8995,7 +9012,7 @@ plain js Object to create an instance from > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Textbox.ts:97](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L97) +Defined in: [src/shapes/Textbox.ts:97](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L97) #### Returns diff --git a/src/content/docs/api/classes/Triangle.md b/src/content/docs/api/classes/Triangle.md index 6122c2f7..d1155170 100644 --- a/src/content/docs/api/classes/Triangle.md +++ b/src/content/docs/api/classes/Triangle.md @@ -5,7 +5,7 @@ prev: false title: "Triangle" --- -Defined in: [src/shapes/Triangle.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Triangle.ts#L12) +Defined in: [src/shapes/Triangle.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Triangle.ts#L12) Exported so we can tweak default values @@ -37,7 +37,7 @@ Exported so we can tweak default values > **new Triangle**\<`Props`, `SProps`, `EventSpec`\>(`options?`): `Triangle`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/shapes/Triangle.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Triangle.ts#L32) +Defined in: [src/shapes/Triangle.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Triangle.ts#L32) Constructor @@ -63,7 +63,7 @@ Options object > `optional` **\_\_corner**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L105) +Defined in: [src/shapes/Object/InteractiveObject.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L108) keeps the value of the last hovered corner during mouse move. 0 is no corner, or 'mt', 'ml', 'mtr' etc.. @@ -81,7 +81,7 @@ this isn't cleaned automatically. Non selected objects may have wrong values > **\_controlsVisibility**: `Record`\<`string`, `boolean`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L112) +Defined in: [src/shapes/Object/InteractiveObject.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L115) a map of control visibility for this object. this was left when controls were introduced to not break the api too much @@ -97,7 +97,7 @@ this takes priority over the generic control visibility > `optional` **\_scaling**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L134) +Defined in: [src/shapes/Object/InteractiveObject.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L137) A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. @@ -119,7 +119,7 @@ DON'T USE IT. WE WILL TRY TO REMOVE IT > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L215) +Defined in: [src/shapes/Object/Object.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L215) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -148,7 +148,7 @@ false > **aCoords**: [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L63) +Defined in: [src/shapes/Object/ObjectGeometry.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L65) Describe object's corner position in scene coordinates. The coordinates are derived from the following: @@ -167,7 +167,7 @@ You can calculate them without updating with [()](/api/classes/triangle/#calcaco > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:581](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L581) +Defined in: [src/shapes/Object/ObjectGeometry.ts:588](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L588) Angle of rotation of an object (in degrees) @@ -191,7 +191,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L202) +Defined in: [src/shapes/Object/Object.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L202) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -210,7 +210,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L74) +Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L77) Color of controlling borders of an object (when it's active) @@ -234,7 +234,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L75) +Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L78) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -256,7 +256,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L76) +Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L79) Opacity of object's controlling borders when object is active and moving @@ -280,7 +280,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L77) +Defined in: [src/shapes/Object/InteractiveObject.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L80) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -308,7 +308,7 @@ you will need to write your own render function for controls > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L216) +Defined in: [src/shapes/Object/Object.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L216) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -334,7 +334,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L217) +Defined in: [src/shapes/Object/Object.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L217) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -357,7 +357,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L213) +Defined in: [src/shapes/Object/Object.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L213) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -378,7 +378,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > `optional` **clipPathId**: `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L16) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L20) 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. @@ -393,7 +393,7 @@ This reference is a UID in the fabric namespace and is temporary stored here. > **controls**: `TControlSet` -Defined in: [src/shapes/Object/InteractiveObject.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L118) +Defined in: [src/shapes/Object/InteractiveObject.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L121) holds the controls for the object. controls are added by default_controls.js @@ -408,7 +408,7 @@ controls are added by default_controls.js > **cornerColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L68) +Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L71) Color of controlling corners of an object (when it's active) @@ -432,7 +432,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/InteractiveObject.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L71) +Defined in: [src/shapes/Object/InteractiveObject.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L74) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -460,7 +460,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L65) +Defined in: [src/shapes/Object/InteractiveObject.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L68) Size of object's controlling corners (in pixels) @@ -484,7 +484,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L69) +Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L72) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -512,7 +512,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L70) +Defined in: [src/shapes/Object/InteractiveObject.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L73) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -546,7 +546,7 @@ This API is no longer supported and may be removed in a future release. > **dirty**: `boolean` -Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L242) +Defined in: [src/shapes/Object/Object.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L242) When set to `true`, object's cache will be rerendered next render call. since 1.7.0 @@ -567,7 +567,7 @@ true > **evented**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L82) +Defined in: [src/shapes/Object/InteractiveObject.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L85) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -585,7 +585,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L209) +Defined in: [src/shapes/Object/Object.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L209) When `true`, object is not exported in OBJECT/JSON @@ -607,7 +607,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L192) +Defined in: [src/shapes/Object/Object.ts:192](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L192) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -632,7 +632,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L193) +Defined in: [src/shapes/Object/Object.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L193) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -658,7 +658,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:567](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L567) +Defined in: [src/shapes/Object/ObjectGeometry.ts:574](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L574) When true, an object is rendered as flipped horizontally @@ -682,7 +682,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:568](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L568) +Defined in: [src/shapes/Object/ObjectGeometry.ts:575](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L575) When true, an object is rendered as flipped vertically @@ -706,7 +706,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L201) +Defined in: [src/shapes/Object/Object.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L201) Composite rule used for canvas globalCompositeOperation @@ -724,7 +724,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L78) +Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L81) When set to `false`, object's controlling borders are not rendered @@ -742,7 +742,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L72) +Defined in: [src/shapes/Object/InteractiveObject.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L75) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -766,7 +766,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:566](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L566) +Defined in: [src/shapes/Object/ObjectGeometry.ts:573](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L573) Object height @@ -784,7 +784,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L86) +Defined in: [src/shapes/Object/InteractiveObject.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L89) Default cursor value used when hovering over this object on canvas @@ -808,7 +808,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L208) +Defined in: [src/shapes/Object/Object.ts:208](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L208) When `false`, default object's values are not included in its serialization @@ -826,7 +826,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L214) +Defined in: [src/shapes/Object/Object.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L214) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -852,7 +852,7 @@ false > `optional` **isMoving**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L124) +Defined in: [src/shapes/Object/InteractiveObject.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L127) internal boolean to signal the code that the object is part of the move action. @@ -867,7 +867,7 @@ part of the move action. > **left**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:564](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L564) +Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L571) Left position of an object. Note that by default it's relative to object left. @@ -893,7 +893,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L56) +Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L59) When `true`, object horizontal movement is locked @@ -911,7 +911,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L57) +Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L60) When `true`, object vertical movement is locked @@ -929,7 +929,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L58) +Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L61) When `true`, object rotation is locked @@ -947,7 +947,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L63) +Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L66) When `true`, object cannot be flipped by scaling into negative values @@ -965,7 +965,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L59) +Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L62) When `true`, object horizontal scaling is locked @@ -983,7 +983,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L60) +Defined in: [src/shapes/Object/InteractiveObject.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L63) When `true`, object vertical scaling is locked @@ -1001,7 +1001,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L61) +Defined in: [src/shapes/Object/InteractiveObject.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L64) When `true`, object horizontal skewing is locked @@ -1019,7 +1019,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L62) +Defined in: [src/shapes/Object/InteractiveObject.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L65) When `true`, object vertical skewing is locked @@ -1037,7 +1037,7 @@ When `true`, object vertical skewing is locked > `optional` **matrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L73) +Defined in: [src/shapes/Object/ObjectGeometry.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L75) storage cache for object full transform matrix @@ -1051,7 +1051,7 @@ storage cache for object full transform matrix > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L187) +Defined in: [src/shapes/Object/Object.ts:187](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L187) Minimum allowed scale value of an object @@ -1075,7 +1075,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L87) +Defined in: [src/shapes/Object/InteractiveObject.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L90) Default cursor value used when moving this object on canvas @@ -1099,11 +1099,11 @@ null > **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L51) +Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L54) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -1127,7 +1127,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L211) +Defined in: [src/shapes/Object/Object.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L211) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -1157,7 +1157,7 @@ true > **oCoords**: `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L95) +Defined in: [src/shapes/Object/InteractiveObject.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L98) The object's controls' position in viewport coordinates Calculated by [Control#positionHandler](/api/classes/control/#positionhandler) and [Control#calcCornerCoords](/api/classes/control/#calccornercoords), depending on [padding](/api/classes/fabricobject/#padding). @@ -1174,7 +1174,7 @@ Used to draw and locate controls. > **opacity**: `number` -Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L189) +Defined in: [src/shapes/Object/Object.ts:189](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L189) Opacity of an object @@ -1198,7 +1198,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L576) +Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L583) :::caution[Deprecated] please use 'center' as value in new projects @@ -1218,7 +1218,7 @@ please use 'center' as value in new projects > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:580](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L580) +Defined in: [src/shapes/Object/ObjectGeometry.ts:587](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L587) :::caution[Deprecated] please use 'center' as value in new projects @@ -1238,7 +1238,7 @@ please use 'center' as value in new projects > `optional` **ownMatrixCache**: `TMatrixCache` -Defined in: [src/shapes/Object/ObjectGeometry.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L68) +Defined in: [src/shapes/Object/ObjectGeometry.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L70) storage cache for object transform matrix @@ -1252,7 +1252,7 @@ storage cache for object transform matrix > **padding**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L53) +Defined in: [src/shapes/Object/ObjectGeometry.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L55) Padding between object and its controlling borders (in pixels) @@ -1276,7 +1276,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L191) +Defined in: [src/shapes/Object/Object.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L191) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1294,7 +1294,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **parent**: [`Group`](/api/classes/group/) -Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1601) +Defined in: [src/shapes/Object/Object.ts:1601](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1601) A reference to the parent of the object Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the `group` ref @@ -1309,7 +1309,7 @@ Used to keep the original parent ref when the object has been added to an Active > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L83) +Defined in: [src/shapes/Object/InteractiveObject.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L86) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1327,7 +1327,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:569](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L569) +Defined in: [src/shapes/Object/ObjectGeometry.ts:576](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L576) Object scale factor (horizontal) @@ -1351,7 +1351,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L570) +Defined in: [src/shapes/Object/ObjectGeometry.ts:577](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L577) Object scale factor (vertical) @@ -1375,7 +1375,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L81) +Defined in: [src/shapes/Object/InteractiveObject.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L84) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1394,7 +1394,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/InteractiveObject.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L79) +Defined in: [src/shapes/Object/InteractiveObject.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L82) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1417,7 +1417,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L204) +Defined in: [src/shapes/Object/Object.ts:204](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L204) Shadow object representing shadow of this shape @@ -1441,7 +1441,7 @@ null > **skewX**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:571](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L571) +Defined in: [src/shapes/Object/ObjectGeometry.ts:578](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L578) Angle of skew on x axes of an object (in degrees) @@ -1465,7 +1465,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L572) +Defined in: [src/shapes/Object/ObjectGeometry.ts:579](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L579) Angle of skew on y axes of an object (in degrees) @@ -1489,7 +1489,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L53) +Defined in: [src/shapes/Object/InteractiveObject.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L56) The angle that an object will lock to while rotating. @@ -1507,7 +1507,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/InteractiveObject.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L54) +Defined in: [src/shapes/Object/InteractiveObject.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L57) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1526,7 +1526,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L194) +Defined in: [src/shapes/Object/Object.ts:194](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L194) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1551,7 +1551,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L195) +Defined in: [src/shapes/Object/Object.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L195) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1575,7 +1575,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L196) +Defined in: [src/shapes/Object/Object.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L196) Line offset of an object's stroke @@ -1599,7 +1599,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L197) +Defined in: [src/shapes/Object/Object.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L197) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1623,7 +1623,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L198) +Defined in: [src/shapes/Object/Object.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L198) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1641,7 +1641,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L199) +Defined in: [src/shapes/Object/Object.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L199) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1665,7 +1665,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:583](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L583) +Defined in: [src/shapes/Object/ObjectGeometry.ts:590](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L590) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1702,7 +1702,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:582](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L582) +Defined in: [src/shapes/Object/ObjectGeometry.ts:589](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L589) Width of a stroke used to render this object @@ -1726,7 +1726,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:563](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L563) +Defined in: [src/shapes/Object/ObjectGeometry.ts:570](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L570) Top position of an object. Note that by default it's relative to object top. @@ -1752,7 +1752,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/InteractiveObject.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L66) +Defined in: [src/shapes/Object/InteractiveObject.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L69) Size of object's controlling corners when touch interaction is detected @@ -1776,7 +1776,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L67) +Defined in: [src/shapes/Object/InteractiveObject.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L70) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1800,7 +1800,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L206) +Defined in: [src/shapes/Object/Object.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L206) When set to `false`, an object is not rendered on canvas @@ -1818,7 +1818,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:565](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L565) +Defined in: [src/shapes/Object/ObjectGeometry.ts:572](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L572) Object width @@ -1836,7 +1836,7 @@ Object width > `static` **cacheProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L234) +Defined in: [src/shapes/Object/Object.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L234) List of properties to consider when checking if cache needs refresh Those properties are checked by @@ -1853,7 +1853,7 @@ and refreshed at the next render > `static` **colorProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1508) +Defined in: [src/shapes/Object/Object.ts:1508](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1508) List of properties to consider for animating colors. @@ -1867,7 +1867,7 @@ List of properties to consider for animating colors. > `static` **customProperties**: `string`[] = `[]` -Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1749) +Defined in: [src/shapes/Object/Object.ts:1749](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1749) Define a list of custom properties that will be serialized when instance.toObject() gets called @@ -1882,7 +1882,7 @@ instance.toObject() gets called > `static` **ownDefaults**: `Partial`\<[`TClassProperties`](/api/type-aliases/tclassproperties/)\<`Triangle`\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\>\> = `triangleDefaultValues` -Defined in: [src/shapes/Triangle.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Triangle.ts#L22) +Defined in: [src/shapes/Triangle.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Triangle.ts#L22) #### Overrides @@ -1894,7 +1894,7 @@ Defined in: [src/shapes/Triangle.ts:22](https://github.com/fabricjs/fabric.js/bl > `static` **stateProperties**: `string`[] -Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L225) +Defined in: [src/shapes/Object/Object.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L225) This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group @@ -1910,7 +1910,7 @@ needs its cache regenerated during a .set call > `static` **type**: `string` = `'Triangle'` -Defined in: [src/shapes/Triangle.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Triangle.ts#L20) +Defined in: [src/shapes/Triangle.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Triangle.ts#L20) The class type. This is used for serialization and deserialization purposes and internally it can be used @@ -1933,7 +1933,7 @@ We do not do that in fabricJS code because we want to try to have code splitting > **get** **type**(): `string` -Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L354) +Defined in: [src/shapes/Object/Object.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L354) Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. @@ -1956,7 +1956,7 @@ This API is no longer supported and may be removed in a future release. > **set** **type**(`value`): `void` -Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L362) +Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L362) ##### Parameters @@ -1978,7 +1978,7 @@ Defined in: [src/shapes/Object/Object.ts:362](https://github.com/fabricjs/fabric > **\_drawClipPath**(`ctx`, `clipPath`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L872) +Defined in: [src/shapes/Object/Object.ts:872](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L872) Prepare clipPath state and cache and draw it on instance's cache @@ -2010,7 +2010,7 @@ Prepare clipPath state and cache and draw it on instance's cache > **\_limitCacheSize**(`dims`): [`TSize`](/api/type-aliases/tsize/) & `object` & `object` -Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L397) +Defined in: [src/shapes/Object/Object.ts:397](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L397) Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit @@ -2040,7 +2040,7 @@ dims > **\_removeCacheCanvas**(): `void` -Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L707) +Defined in: [src/shapes/Object/Object.ts:707](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L707) Remove cacheCanvas and its dimensions from the objects @@ -2058,7 +2058,7 @@ Remove cacheCanvas and its dimensions from the objects > **\_renderControls**(`ctx`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:435](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L435) +Defined in: [src/shapes/Object/InteractiveObject.ts:440](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L440) Renders controls and borders for the object the context here is not transformed @@ -2095,7 +2095,7 @@ move to interactivity > **\_setClippingProperties**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1017) +Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1017) #### Parameters @@ -2117,7 +2117,7 @@ Defined in: [src/shapes/Object/Object.ts:1017](https://github.com/fabricjs/fabri > **\_setFillStyles**(`ctx`, `__namedParameters`): `void` -Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1006) +Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1006) #### Parameters @@ -2143,7 +2143,7 @@ Defined in: [src/shapes/Object/Object.ts:1006](https://github.com/fabricjs/fabri > **\_setStrokeStyles**(`ctx`, `decl`): `void` -Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L964) +Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L964) #### Parameters @@ -2169,7 +2169,7 @@ Defined in: [src/shapes/Object/Object.ts:964](https://github.com/fabricjs/fabric > **\_setupCompositeOperation**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1483) +Defined in: [src/shapes/Object/Object.ts:1483](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1483) Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property @@ -2196,7 +2196,7 @@ Rendering canvas context > **\_toSVG**(): `string`[] -Defined in: [src/shapes/Triangle.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Triangle.ts#L60) +Defined in: [src/shapes/Triangle.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Triangle.ts#L60) Returns svg representation of an instance @@ -2217,7 +2217,7 @@ of the instance > **addPaintOrder**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L255) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L265) #### Parameters @@ -2239,7 +2239,7 @@ Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:255](https://github > **animate**\<`T`\>(`animatable`, `options?`): `Record`\<`string`, [`TAnimation`](/api/fabric/namespaces/util/type-aliases/tanimation/)\<`T`\>\> -Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1522) +Defined in: [src/shapes/Object/Object.ts:1522](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1522) Animates object's properties @@ -2286,7 +2286,7 @@ object.animate({ left: ..., top: ... }, { duration: ... }); > **calcACoords**(): [`TCornerPoint`](/api/type-aliases/tcornerpoint/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:427](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L427) +Defined in: [src/shapes/Object/ObjectGeometry.ts:429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L429) Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes. @@ -2305,7 +2305,7 @@ those never change with zoom or viewport changes. > **calcOCoords**(): `Record`\<`string`, `TOCoord`\> -Defined in: [src/shapes/Object/InteractiveObject.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L255) +Defined in: [src/shapes/Object/InteractiveObject.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L258) Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler @@ -2326,7 +2326,7 @@ is a public api and should be done just if extremely necessary > **calcOwnMatrix**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:513](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L513) +Defined in: [src/shapes/Object/ObjectGeometry.ts:515](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L515) calculate transform matrix that represents the current transformations from the object's properties, this matrix does not include the group transformation @@ -2347,7 +2347,7 @@ transform matrix for the object > **calcTransformMatrix**(`skipGroup?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:485](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L485) +Defined in: [src/shapes/Object/ObjectGeometry.ts:487](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L487) calculate transform matrix that represents the current transformations from the object's properties. @@ -2377,7 +2377,7 @@ transform matrix for the object > **canDrop**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L701) +Defined in: [src/shapes/Object/InteractiveObject.ts:711](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L711) Override to customize drag and drop behavior @@ -2403,7 +2403,7 @@ true if the object currently dragged can be dropped on the target > **clearContextTop**(`restoreManually?`): `undefined` \| `CanvasRenderingContext2D` -Defined in: [src/shapes/Object/InteractiveObject.ts:627](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L627) +Defined in: [src/shapes/Object/InteractiveObject.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L637) Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box that is in the canvas.contextContainer. @@ -2439,7 +2439,7 @@ discuss swapping restoreManually with a renderCallback, but think of async issue > **clone**(`propertiesToInclude?`): `Promise`\<`Triangle`\<`Props`, `SProps`, `EventSpec`\>\> -Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1245) +Defined in: [src/shapes/Object/Object.ts:1245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1245) Clones an instance. @@ -2465,7 +2465,7 @@ Any properties that you might want to additionally include in the output > **cloneAsImage**(`options?`): [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1271) +Defined in: [src/shapes/Object/Object.ts:1271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1271) Creates an instance of Image out of an object makes use of toCanvasElement. @@ -2502,7 +2502,7 @@ fix the export type, it could not be Image but the type that getClass return for > **complexity**(): `number` -Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1429) +Defined in: [src/shapes/Object/Object.ts:1429](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1429) Returns complexity of an instance @@ -2522,7 +2522,7 @@ complexity of this instance (is 1 unless subclassed) > **containsPoint**(`point`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L282) +Defined in: [src/shapes/Object/ObjectGeometry.ts:284](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L284) Checks if point is inside the object @@ -2550,7 +2550,7 @@ true if point is inside the object > **dispose**(): `void` -Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1493) +Defined in: [src/shapes/Object/Object.ts:1493](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1493) cancel instance's running animations override if necessary to dispose artifacts such as `clipPath` @@ -2569,7 +2569,7 @@ override if necessary to dispose artifacts such as `clipPath` > **drawBorders**(`ctx`, `options`, `styleOverride?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L478) +Defined in: [src/shapes/Object/InteractiveObject.ts:488](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L488) Draws borders of an object's bounding box. Requires public properties: width, height @@ -2609,7 +2609,7 @@ object to override the object style > **drawCacheOnCanvas**(`this`, `ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L894) +Defined in: [src/shapes/Object/Object.ts:894](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L894) Paint the cached copy of the object on the target context. @@ -2639,7 +2639,7 @@ Context to render on > **drawClipPathOnCache**(`ctx`, `clipPath`, `canvasWithClipPath`): `void` -Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L799) +Defined in: [src/shapes/Object/Object.ts:799](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L799) Execute the drawing operation for an object clipPath @@ -2673,7 +2673,7 @@ Context to render on > **drawControls**(`ctx`, `styleOverride`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:550](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L550) +Defined in: [src/shapes/Object/InteractiveObject.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L560) Draws corners of an object's bounding box. Requires public properties: width, height @@ -2710,7 +2710,7 @@ object to override the object style > **drawControlsConnectingLines**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L517) +Defined in: [src/shapes/Object/InteractiveObject.ts:527](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L527) Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set. Requires public properties: width, height @@ -2744,7 +2744,7 @@ object size x = width, y = height > **drawObject**(`ctx`, `forClipping`, `context`): `void` -Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L823) +Defined in: [src/shapes/Object/Object.ts:823](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L823) Execute the drawing operation for an object on a specified context @@ -2782,7 +2782,7 @@ additional context for rendering > **drawSelectionBackground**(`ctx`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:375](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L375) +Defined in: [src/shapes/Object/InteractiveObject.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L380) Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor @@ -2817,7 +2817,7 @@ it seemed a good option, now is an edge case > **findCommonAncestors**\<`T`\>(`other`): `AncestryComparison` -Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1640) +Defined in: [src/shapes/Object/Object.ts:1640](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1640) Compare ancestors @@ -2849,7 +2849,7 @@ an object that represent the ancestry situation. > **fire**\<`K`\>(`eventName`, `options?`): `void` -Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L167) +Defined in: [src/Observable.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L167) Fires event with an optional options object @@ -2887,7 +2887,7 @@ Options object > **forEachControl**(`fn`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:353](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L353) +Defined in: [src/shapes/Object/InteractiveObject.ts:358](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L358) 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 @@ -2914,7 +2914,7 @@ function to iterate over the controls over > **get**(`property`): `any` -Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L59) +Defined in: [src/CommonMethods.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L59) Basic getter @@ -2942,7 +2942,7 @@ value of a property > **getActiveControl**(): `undefined` \| \{ `control`: [`Control`](/api/classes/control/); `coord`: `TOCoord`; `key`: `string`; \} -Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L194) +Defined in: [src/shapes/Object/InteractiveObject.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L197) #### Returns @@ -2958,7 +2958,7 @@ Defined in: [src/shapes/Object/InteractiveObject.ts:194](https://github.com/fabr > **getAncestors**(): `Ancestors` -Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1623) +Defined in: [src/shapes/Object/Object.ts:1623](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1623) #### Returns @@ -2976,7 +2976,7 @@ ancestors (excluding `ActiveSelection`) from bottom to top > **getBoundingRect**(): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L343) +Defined in: [src/shapes/Object/ObjectGeometry.ts:345](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L345) Returns coordinates of object's bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas. @@ -2997,7 +2997,7 @@ Object with left, top, width, height properties > **getCanvasRetinaScaling**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L400) +Defined in: [src/shapes/Object/ObjectGeometry.ts:402](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L402) #### Returns @@ -3013,7 +3013,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:400](https://github.com/fabricj > **getCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:733](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L733) +Defined in: [src/shapes/Object/ObjectGeometry.ts:740](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L740) Returns the center coordinates of the object relative to canvas @@ -3031,7 +3031,7 @@ Returns the center coordinates of the object relative to canvas > **getCoords**(): [`Point`](/api/classes/point/)[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L204) +Defined in: [src/shapes/Object/ObjectGeometry.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L206) #### Returns @@ -3049,7 +3049,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:204](https://github.com/fabricj > **getObjectOpacity**(): `number` -Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L560) +Defined in: [src/shapes/Object/Object.ts:560](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L560) Return the object opacity counting also the group property @@ -3067,7 +3067,7 @@ Return the object opacity counting also the group property > **getObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L529) +Defined in: [src/shapes/Object/Object.ts:529](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L529) Return the object scale factor counting also the group scaling @@ -3085,7 +3085,7 @@ Return the object scale factor counting also the group scaling > **getPointByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L756) +Defined in: [src/shapes/Object/ObjectGeometry.ts:763](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L763) Alias of [getPositionByOrigin](/api/classes/triangle/#getpositionbyorigin) @@ -3117,7 +3117,7 @@ use [getPositionByOrigin](/api/classes/triangle/#getpositionbyorigin) instead > **getPositionByOrigin**(`originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:772](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L772) +Defined in: [src/shapes/Object/ObjectGeometry.ts:779](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L779) This function is the mirror of [setPositionByOrigin](/api/classes/triangle/#setpositionbyorigin) Returns the position of the object based on specified origin. @@ -3155,7 +3155,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **getRelativeCenterPoint**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:744](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L744) +Defined in: [src/shapes/Object/ObjectGeometry.ts:751](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L751) Returns the center coordinates of the object relative to it's parent @@ -3173,7 +3173,7 @@ Returns the center coordinates of the object relative to it's parent > **getRelativeX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L115) +Defined in: [src/shapes/Object/ObjectGeometry.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L117) #### Returns @@ -3192,7 +3192,7 @@ if parent is canvas then this property is identical to [getX](/api/classes/trian > **getRelativeXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:176](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L176) +Defined in: [src/shapes/Object/ObjectGeometry.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L178) #### Returns @@ -3210,7 +3210,7 @@ x,y position according to object's originX originY properties in parent's coordi > **getRelativeY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L131) +Defined in: [src/shapes/Object/ObjectGeometry.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L133) #### Returns @@ -3229,7 +3229,7 @@ if parent is canvas then this property is identical to [getY](/api/classes/trian > **getScaledHeight**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:361](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L361) +Defined in: [src/shapes/Object/ObjectGeometry.ts:363](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L363) Returns height of an object bounding box counting transformations @@ -3253,7 +3253,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getScaledWidth**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L352) +Defined in: [src/shapes/Object/ObjectGeometry.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L354) Returns width of an object's bounding box counting transformations @@ -3277,7 +3277,7 @@ shouldn't this account for group transform and return the actual size in canvas > **getSvgCommons**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L100) Returns id attribute for svg output @@ -3301,7 +3301,7 @@ Returns id attribute for svg output > **getSvgFilter**(`this`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L80) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L90) Returns filter for svg shadow @@ -3325,7 +3325,7 @@ Returns filter for svg shadow > **getSvgStyles**(`this`, `skipShadow?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L23) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L27) Returns styles-string for svg-export @@ -3355,7 +3355,7 @@ a boolean to skip shadow filter output > **getSvgTransform**(`this`, `full?`, `additionalTransform?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L109) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L119) Returns transform-string for svg-export @@ -3387,7 +3387,7 @@ Returns transform-string for svg-export > **getTotalAngle**(): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:408](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L408) +Defined in: [src/shapes/Object/ObjectGeometry.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L410) Returns the object angle relative to canvas counting also the group property @@ -3405,7 +3405,7 @@ Returns the object angle relative to canvas counting also the group property > **getTotalObjectScaling**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L546) +Defined in: [src/shapes/Object/Object.ts:546](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L546) Return the object scale factor counting also the group scaling, zoom and retina @@ -3425,7 +3425,7 @@ object with scaleX and scaleY properties > **getViewportTransform**(): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L418) +Defined in: [src/shapes/Object/ObjectGeometry.ts:420](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L420) Retrieves viewportTransform from Object's canvas if available @@ -3443,7 +3443,7 @@ Retrieves viewportTransform from Object's canvas if available > **getX**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L86) +Defined in: [src/shapes/Object/ObjectGeometry.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L88) #### Returns @@ -3461,7 +3461,7 @@ x position according to object's originX property in canvas coordinate plane > **getXY**(): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L146) +Defined in: [src/shapes/Object/ObjectGeometry.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L148) #### Returns @@ -3479,7 +3479,7 @@ x position according to object's originX originY properties in canvas coordinate > **getY**(): `number` -Defined in: [src/shapes/Object/ObjectGeometry.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L100) +Defined in: [src/shapes/Object/ObjectGeometry.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L102) #### Returns @@ -3497,7 +3497,7 @@ y position according to object's originY property in canvas coordinate plane > **hasCommonAncestors**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1705) +Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1705) #### Type Parameters @@ -3525,7 +3525,7 @@ Defined in: [src/shapes/Object/Object.ts:1705](https://github.com/fabricjs/fabri > **hasFill**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L738) +Defined in: [src/shapes/Object/Object.ts:738](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L738) return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time @@ -3554,7 +3554,7 @@ Boolean > **hasStroke**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L722) +Defined in: [src/shapes/Object/Object.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L722) return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time @@ -3583,7 +3583,7 @@ Boolean > **intersectsWithObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:232](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L232) +Defined in: [src/shapes/Object/ObjectGeometry.ts:234](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L234) Checks if object intersects with another object @@ -3611,7 +3611,7 @@ true if object intersects with another object > **intersectsWithRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:218](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L218) +Defined in: [src/shapes/Object/ObjectGeometry.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L220) Checks if object intersects with the scene rect formed by tl and br @@ -3639,7 +3639,7 @@ Checks if object intersects with the scene rect formed by tl and br > **isCacheDirty**(`skipCanvas`): `boolean` -Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L911) +Defined in: [src/shapes/Object/Object.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L911) Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. @@ -3669,7 +3669,7 @@ on parent canvas. > **isContainedWithinObject**(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:251](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L251) +Defined in: [src/shapes/Object/ObjectGeometry.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L253) Checks if object is fully contained within area of another object @@ -3697,7 +3697,7 @@ true if object is fully contained within area of another object > **isContainedWithinRect**(`tl`, `br`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L259) +Defined in: [src/shapes/Object/ObjectGeometry.ts:261](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L261) Checks if object is fully contained within the scene rect formed by tl and br @@ -3725,7 +3725,7 @@ Checks if object is fully contained within the scene rect formed by tl and br > **isControlVisible**(`controlKey`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:584](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L584) +Defined in: [src/shapes/Object/InteractiveObject.ts:594](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L594) Returns true if the specified control is visible, false otherwise. @@ -3754,7 +3754,7 @@ true if the specified control is visible, false otherwise > **isDescendantOf**(`target`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1609) +Defined in: [src/shapes/Object/Object.ts:1609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1609) Checks if object is descendant of target Should be used instead of [Group.contains](/api/classes/group/#contains) or [StaticCanvas.contains](/api/classes/staticcanvas/#contains) for performance reasons @@ -3779,7 +3779,7 @@ Should be used instead of [Group.contains](/api/classes/group/#contains) or [Sta > **isInFrontOf**\<`T`\>(`other`): `undefined` \| `boolean` -Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1715) +Defined in: [src/shapes/Object/Object.ts:1715](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1715) #### Type Parameters @@ -3811,7 +3811,7 @@ if objects do not share a common ancestor or they are strictly equal it is impos > **isNotVisible**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L637) +Defined in: [src/shapes/Object/Object.ts:637](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L637) return if the object would be visible in rendering @@ -3829,7 +3829,7 @@ return if the object would be visible in rendering > **isOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:291](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L291) +Defined in: [src/shapes/Object/ObjectGeometry.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L293) Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen @@ -3850,7 +3850,7 @@ true if object is fully or partially contained within canvas > **isOverlapping**\<`T`\>(`other`): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L269) +Defined in: [src/shapes/Object/ObjectGeometry.ts:271](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L271) #### Type Parameters @@ -3878,7 +3878,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:269](https://github.com/fabricj > **isPartiallyOnScreen**(): `boolean` -Defined in: [src/shapes/Object/ObjectGeometry.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L321) +Defined in: [src/shapes/Object/ObjectGeometry.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L323) Checks if object is partially contained within the canvas with current viewportTransform @@ -3898,7 +3898,7 @@ true if object is partially contained within canvas > **isType**(...`types`): `boolean` -Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1418) +Defined in: [src/shapes/Object/Object.ts:1418](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1418) Checks if the instance is of any of the specified types. We use this to filter a list of objects for the `getObjects` function. @@ -3934,7 +3934,7 @@ A list of type strings to check against. > **needsItsOwnCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L750) +Defined in: [src/shapes/Object/Object.ts:750](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L750) When returns `true`, force the object to have its own cache, even if it is inside a group it may be needed when your object behave in a particular way on the cache and always needs @@ -3960,7 +3960,7 @@ Boolean > **off**\<`K`\>(`eventName`): `void` -Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L122) +Defined in: [src/Observable.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L122) Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. @@ -3996,7 +3996,7 @@ event name (eg. 'after:render') > **off**\<`K`\>(`eventName`, `handler`): `void` -Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L128) +Defined in: [src/Observable.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L128) unsubscribe an event listener @@ -4032,7 +4032,7 @@ event listener to unsubscribe > **off**(`handlers`): `void` -Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L133) +Defined in: [src/Observable.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L133) unsubscribe event listeners @@ -4056,7 +4056,7 @@ handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': han > **off**(): `void` -Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L137) +Defined in: [src/Observable.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L137) unsubscribe all event listeners @@ -4076,7 +4076,7 @@ unsubscribe all event listeners > **on**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L23) +Defined in: [src/Observable.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L23) Observes specified event @@ -4122,7 +4122,7 @@ on > **on**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L27) +Defined in: [src/Observable.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L27) Observes specified event @@ -4156,7 +4156,7 @@ on > **once**\<`K`, `E`\>(`eventName`, `handler`): `VoidFunction` -Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L62) +Defined in: [src/Observable.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L62) Observes specified event **once** @@ -4202,7 +4202,7 @@ once > **once**(`handlers`): `VoidFunction` -Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Observable.ts#L66) +Defined in: [src/Observable.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Observable.ts#L66) Observes specified event **once** @@ -4234,7 +4234,7 @@ once > **onDeselect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:658](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L658) +Defined in: [src/shapes/Object/InteractiveObject.ts:668](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L668) 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 @@ -4267,7 +4267,7 @@ options sent from the upper functions > **onDragStart**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:691](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L691) +Defined in: [src/shapes/Object/InteractiveObject.ts:701](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L701) Override to customize Drag behavior\ Fired once a drag session has started @@ -4294,7 +4294,7 @@ true to handle the drag event > **onSelect**(`_options?`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:672](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L672) +Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L682) 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 @@ -4325,7 +4325,7 @@ event if the process is generated by an event > **positionByLeftTop**(`p`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:809](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L809) +Defined in: [src/shapes/Object/ObjectGeometry.ts:816](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L816) An utility method to position the object by its left top corner. Useful to reposition objects since now the default origin is center/center @@ -4351,7 +4351,7 @@ Places the left/top corner of the object bounding box in p. > **render**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L649) +Defined in: [src/shapes/Object/Object.ts:649](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L649) Renders an object on a specified context @@ -4377,7 +4377,7 @@ Context to render on > **renderCache**(`this`, `options?`): `void` -Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L683) +Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L683) #### Parameters @@ -4403,7 +4403,7 @@ Defined in: [src/shapes/Object/Object.ts:683](https://github.com/fabricjs/fabric > **renderDragSourceEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:712](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L712) +Defined in: [src/shapes/Object/InteractiveObject.ts:722](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L722) Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event @@ -4429,7 +4429,7 @@ example: render the selection status for the part of text that is being dragged > **renderDropTargetEffect**(`_e`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:724](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L724) +Defined in: [src/shapes/Object/InteractiveObject.ts:734](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L734) Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event @@ -4456,7 +4456,7 @@ object will change when dropping. example: show the cursor where the text is abo > **rotate**(`angle`): `void` -Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1446) +Defined in: [src/shapes/Object/Object.ts:1446](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1446) Sets "angle" of an instance with centered rotation @@ -4482,7 +4482,7 @@ Angle value (in degrees) > **scale**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:370](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L370) +Defined in: [src/shapes/Object/ObjectGeometry.ts:372](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L372) Scales an object (equally by x and y) @@ -4508,7 +4508,7 @@ Scale factor > **scaleToHeight**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:393](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L393) +Defined in: [src/shapes/Object/ObjectGeometry.ts:395](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L395) Scales an object to a given height, with respect to bounding box (scaling by x/y equally) @@ -4534,7 +4534,7 @@ New height value > **scaleToWidth**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:381](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L381) +Defined in: [src/shapes/Object/ObjectGeometry.ts:383](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L383) Scales an object to a given width, with respect to bounding box (scaling by x/y equally) @@ -4560,7 +4560,7 @@ New width value > **set**(`key`, `value?`): `Triangle`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L29) +Defined in: [src/CommonMethods.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L29) Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. If you need to update those, call `setCoords()`. @@ -4592,7 +4592,7 @@ Property value (if function, the value is passed into it and its return value is > **setControlsVisibility**(`options?`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:611](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L611) +Defined in: [src/shapes/Object/InteractiveObject.ts:621](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L621) Sets the visibility state of object controls, this is just a bulk option for setControlVisible; @@ -4619,7 +4619,7 @@ example: {Boolean} [options.bl] true to enable the bottom-left control, false to > **setControlVisible**(`controlKey`, `visible`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:599](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L599) +Defined in: [src/shapes/Object/InteractiveObject.ts:609](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L609) Sets the visibility of the specified control. please do not use. @@ -4657,7 +4657,7 @@ discuss this overlap of priority here with the team. Andrea Bogazzi for details > **setCoords**(): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L343) +Defined in: [src/shapes/Object/InteractiveObject.ts:348](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L348) set controls' coordinates as well See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords) and [https://fabric5.fabricjs.com/fabric-gotchas](https://fabric5.fabricjs.com/fabric-gotchas) @@ -4676,7 +4676,7 @@ See [https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords](https:// > **setOnGroup**(): `void` -Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1474) +Defined in: [src/shapes/Object/Object.ts:1474](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1474) This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key @@ -4697,7 +4697,7 @@ Travis build error about unused variables. > **setPositionByOrigin**(`pos`, `originX`, `originY`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:787](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L787) +Defined in: [src/shapes/Object/ObjectGeometry.ts:794](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L794) Sets the position of the object taking into consideration the object's origin @@ -4735,7 +4735,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L123) +Defined in: [src/shapes/Object/ObjectGeometry.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L125) #### Parameters @@ -4760,7 +4760,7 @@ if parent is canvas then this method is identical to [setX](/api/classes/triangl > **setRelativeXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:186](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L186) +Defined in: [src/shapes/Object/ObjectGeometry.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L188) As [setXY](/api/classes/triangle/#setxy), but in current parent's coordinate plane (the current group if any or the canvas) @@ -4798,7 +4798,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **setRelativeY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L139) +Defined in: [src/shapes/Object/ObjectGeometry.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L141) #### Parameters @@ -4823,7 +4823,7 @@ if parent is canvas then this property is identical to [setY](/api/classes/trian > **setX**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L93) +Defined in: [src/shapes/Object/ObjectGeometry.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L95) #### Parameters @@ -4847,7 +4847,7 @@ x position according to object's originX property in canvas coordinate plane > **setXY**(`point`, `originX?`, `originY?`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:163](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L163) +Defined in: [src/shapes/Object/ObjectGeometry.ts:165](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L165) Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, @@ -4893,7 +4893,7 @@ object.setXY(new Point(5, 5), 'left', 'bottom'). > **setY**(`value`): `void` -Defined in: [src/shapes/Object/ObjectGeometry.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L107) +Defined in: [src/shapes/Object/ObjectGeometry.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L109) #### Parameters @@ -4917,7 +4917,7 @@ y position according to object's originY property in canvas coordinate plane > **shouldCache**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L775) +Defined in: [src/shapes/Object/Object.ts:775](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L775) Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything @@ -4940,7 +4940,7 @@ Read as: cache if is needed, or if the feature is enabled but we are not already > **shouldStartDragging**(`_e`): `boolean` -Defined in: [src/shapes/Object/InteractiveObject.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L682) +Defined in: [src/shapes/Object/InteractiveObject.ts:692](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L692) Override to customize Drag behavior Fired from Canvas#\_onMouseMove @@ -4967,7 +4967,7 @@ true in order for the window to start a drag session > **strokeBorders**(`ctx`, `size`): `void` -Defined in: [src/shapes/Object/InteractiveObject.ts:399](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L399) +Defined in: [src/shapes/Object/InteractiveObject.ts:404](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L404) override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style. @@ -4999,7 +4999,7 @@ the control box size used > **toBlob**(`options`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1396) +Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1396) #### Parameters @@ -5021,7 +5021,7 @@ Defined in: [src/shapes/Object/Object.ts:1396](https://github.com/fabricjs/fabri > **toCanvasElement**(`options`): `HTMLCanvasElement` -Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1293) +Defined in: [src/shapes/Object/Object.ts:1293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1293) Converts an object into a HTMLCanvas element @@ -5049,7 +5049,7 @@ Returns DOM element with the FabricObject > **toClipPathSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L149) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L159) Returns svg clipPath representation of an instance @@ -5081,7 +5081,7 @@ svg representation of an instance > **toDatalessObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1849) +Defined in: [src/shapes/Object/Object.ts:1849](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1849) Returns (dataless) object representation of an instance @@ -5109,7 +5109,7 @@ Object representation of an instance > **toDataURL**(`options`): `string` -Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1389) +Defined in: [src/shapes/Object/Object.ts:1389](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1389) Converts an object into a data-url-like string @@ -5137,7 +5137,7 @@ Returns a data: URL containing a representation of the object in the format spec > **toggle**(`property`): `Triangle`\<`Props`, `SProps`, `EventSpec`\> -Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/CommonMethods.ts#L46) +Defined in: [src/CommonMethods.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/CommonMethods.ts#L46) Toggles specified property from `true` to `false` or from `false` to `true` @@ -5163,7 +5163,7 @@ Property to toggle > **toJSON**(): `any` -Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1437) +Defined in: [src/shapes/Object/Object.ts:1437](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1437) Returns a JSON representation of an instance @@ -5183,7 +5183,7 @@ JSON > **toObject**(`propertiesToInclude?`): `any` -Defined in: [src/shapes/Object/Object.ts:1756](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1756) +Defined in: [src/shapes/Object/Object.ts:1756](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1756) Returns an object representation of an instance @@ -5211,7 +5211,7 @@ Object representation of an instance > **toString**(): `string` -Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1889) +Defined in: [src/shapes/Object/Object.ts:1889](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1889) Returns a string representation of an instance @@ -5229,7 +5229,7 @@ Returns a string representation of an instance > **toSVG**(`this`, `reviver?`): `string` -Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/FabricObjectSVGExportMixin.ts#L135) +Defined in: [src/shapes/Object/FabricObjectSVGExportMixin.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/FabricObjectSVGExportMixin.ts#L145) Returns svg representation of an instance @@ -5261,7 +5261,7 @@ svg representation of an instance > **transform**(`ctx`): `void` -Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L517) +Defined in: [src/shapes/Object/Object.ts:517](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L517) Transforms context when rendering an object @@ -5287,7 +5287,7 @@ Context > **transformMatrixKey**(`skipGroup`): `number`[] -Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L453) +Defined in: [src/shapes/Object/ObjectGeometry.ts:455](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L455) #### Parameters @@ -5309,7 +5309,7 @@ Defined in: [src/shapes/Object/ObjectGeometry.ts:453](https://github.com/fabricj > **translateToCenterPoint**(`point`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:683](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L683) +Defined in: [src/shapes/Object/ObjectGeometry.ts:690](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L690) Translates the coordinates from origin to center coordinates (based on the object's dimensions) @@ -5347,7 +5347,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToGivenOrigin**(`point`, `fromOriginX`, `fromOriginY`, `toOriginX`, `toOriginY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:655](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L655) +Defined in: [src/shapes/Object/ObjectGeometry.ts:662](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L662) Translates the coordinates from a set of origin to another (based on the object's dimensions) @@ -5397,7 +5397,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **translateToOriginPoint**(`center`, `originX`, `originY`): [`Point`](/api/classes/point/) -Defined in: [src/shapes/Object/ObjectGeometry.ts:711](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/ObjectGeometry.ts#L711) +Defined in: [src/shapes/Object/ObjectGeometry.ts:718](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/ObjectGeometry.ts#L718) Translates the coordinates from center to origin coordinates (based on the object's dimensions) @@ -5435,7 +5435,7 @@ Vertical origin: 'top', 'center' or 'bottom' > **willDrawShadow**(): `boolean` -Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L788) +Defined in: [src/shapes/Object/Object.ts:788](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L788) Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively @@ -5458,7 +5458,7 @@ This API is no longer supported and may be removed in a future release. > `static` **\_fromObject**\<`S`\>(`__namedParameters`, `__namedParameters`): `Promise`\<`S`\> -Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1902) +Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1902) #### Type Parameters @@ -5490,7 +5490,7 @@ Defined in: [src/shapes/Object/Object.ts:1902](https://github.com/fabricjs/fabri > `static` **createControls**(): `object` -Defined in: [src/shapes/Object/InteractiveObject.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/InteractiveObject.ts#L167) +Defined in: [src/shapes/Object/InteractiveObject.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/InteractiveObject.ts#L170) Creates the default control object. If you prefer to have on instance of controls shared among all objects @@ -5514,7 +5514,7 @@ make this function return an empty object and add controls to the ownDefaults > `static` **fromObject**\<`T`\>(`object`, `options?`): `Promise`\<[`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>\> -Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L1931) +Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L1931) #### Type Parameters @@ -5546,7 +5546,7 @@ Defined in: [src/shapes/Object/Object.ts:1931](https://github.com/fabricjs/fabri > `static` **getDefaults**(): `Record`\<`string`, `any`\> -Defined in: [src/shapes/Triangle.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Triangle.ts#L24) +Defined in: [src/shapes/Triangle.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Triangle.ts#L24) #### Returns diff --git a/src/content/docs/api/classes/WebGLFilterBackend.md b/src/content/docs/api/classes/WebGLFilterBackend.md index 70f86235..0008bfcf 100644 --- a/src/content/docs/api/classes/WebGLFilterBackend.md +++ b/src/content/docs/api/classes/WebGLFilterBackend.md @@ -5,7 +5,7 @@ prev: false title: "WebGLFilterBackend" --- -Defined in: [src/filters/WebGLFilterBackend.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L11) +Defined in: [src/filters/WebGLFilterBackend.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L11) ## Constructors @@ -13,7 +13,7 @@ Defined in: [src/filters/WebGLFilterBackend.ts:11](https://github.com/fabricjs/f > **new WebGLFilterBackend**(`__namedParameters`): `WebGLFilterBackend` -Defined in: [src/filters/WebGLFilterBackend.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L56) +Defined in: [src/filters/WebGLFilterBackend.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L56) #### Parameters @@ -33,7 +33,7 @@ Defined in: [src/filters/WebGLFilterBackend.ts:56](https://github.com/fabricjs/f > **aPosition**: `Float32Array` -Defined in: [src/filters/WebGLFilterBackend.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L17) +Defined in: [src/filters/WebGLFilterBackend.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L17) Define ... @@ -43,7 +43,7 @@ Define ... > **canvas**: `HTMLCanvasElement` -Defined in: [src/filters/WebGLFilterBackend.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L25) +Defined in: [src/filters/WebGLFilterBackend.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L25) *** @@ -51,7 +51,7 @@ Defined in: [src/filters/WebGLFilterBackend.ts:25](https://github.com/fabricjs/f > **gl**: `WebGLRenderingContext` -Defined in: [src/filters/WebGLFilterBackend.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L30) +Defined in: [src/filters/WebGLFilterBackend.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L30) The Webgl context that will execute the operations for filtering @@ -61,7 +61,7 @@ The Webgl context that will execute the operations for filtering > **gpuInfo**: `any` -Defined in: [src/filters/WebGLFilterBackend.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L45) +Defined in: [src/filters/WebGLFilterBackend.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L45) Contains GPU info for debug @@ -71,7 +71,7 @@ Contains GPU info for debug > `optional` **imageBuffer**: `ArrayBuffer` -Defined in: [src/filters/WebGLFilterBackend.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L23) +Defined in: [src/filters/WebGLFilterBackend.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L23) If GLPut data is the fastest operation, or if forced, this buffer will be used to transfer the data back in the 2d logic @@ -82,7 +82,7 @@ to transfer the data back in the 2d logic > **programCache**: `any` -Defined in: [src/filters/WebGLFilterBackend.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L35) +Defined in: [src/filters/WebGLFilterBackend.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L35) Keyed map for shader cache @@ -92,7 +92,7 @@ Keyed map for shader cache > **resources**: [`TPipelineResources`](/api/type-aliases/tpipelineresources/) = `{}` -Defined in: [src/filters/WebGLFilterBackend.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L54) +Defined in: [src/filters/WebGLFilterBackend.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L54) Experimental. This object is a sort of repository of help layers used to avoid of recreating them during frequent filtering. If you are previewing a filter with @@ -106,7 +106,7 @@ cleared never. Clearing is left to the developer. > **textureCache**: [`TTextureCache`](/api/type-aliases/ttexturecache/) -Defined in: [src/filters/WebGLFilterBackend.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L40) +Defined in: [src/filters/WebGLFilterBackend.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L40) Keyed map for texture cache @@ -116,7 +116,7 @@ Keyed map for texture cache > **tileSize**: `number` -Defined in: [src/filters/WebGLFilterBackend.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L12) +Defined in: [src/filters/WebGLFilterBackend.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L12) ## Methods @@ -124,7 +124,7 @@ Defined in: [src/filters/WebGLFilterBackend.ts:12](https://github.com/fabricjs/f > **applyFilters**(`filters`, `source`, `width`, `height`, `targetCanvas`, `cacheKey?`): `undefined` \| [`TWebGLPipelineState`](/api/type-aliases/twebglpipelinestate/) -Defined in: [src/filters/WebGLFilterBackend.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L106) +Defined in: [src/filters/WebGLFilterBackend.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L106) Attempts to apply the requested filters to the source provided, drawing the filtered output to the provided target canvas. @@ -133,7 +133,7 @@ to the provided target canvas. ##### filters -[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\>[] +[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>[] The filters to apply. @@ -178,7 +178,7 @@ omitted, caching will be skipped. > **captureGPUInfo**(): `any` -Defined in: [src/filters/WebGLFilterBackend.ts:380](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L380) +Defined in: [src/filters/WebGLFilterBackend.ts:380](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L380) Attempt to extract GPU information strings from a WebGL context. @@ -196,7 +196,7 @@ A GPU info object with renderer and vendor strings. > **clearWebGLCaches**(): `void` -Defined in: [src/filters/WebGLFilterBackend.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L193) +Defined in: [src/filters/WebGLFilterBackend.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L193) Wipe out WebGL-related caches. @@ -210,7 +210,7 @@ Wipe out WebGL-related caches. > **copyGLTo2D**(`gl`, `pipelineState`): `void` -Defined in: [src/filters/WebGLFilterBackend.ts:320](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L320) +Defined in: [src/filters/WebGLFilterBackend.ts:320](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L320) Copy an input WebGL canvas on to an output 2D canvas. @@ -239,7 +239,7 @@ The 2D target canvas to copy on to. > **copyGLTo2DPutImageData**(`this`, `gl`, `pipelineState`): `void` -Defined in: [src/filters/WebGLFilterBackend.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L352) +Defined in: [src/filters/WebGLFilterBackend.ts:352](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L352) Copy an input WebGL canvas on to an output 2D canvas using 2d canvas' putImageData API. Measurably faster than using ctx.drawImage in Firefox (version 54 on OSX Sierra). @@ -270,7 +270,7 @@ The 2D target canvas to copy on to. > **createTexture**(`gl`, `width`, `height`, `textureImageSource?`, `filter?`): `WebGLTexture` -Defined in: [src/filters/WebGLFilterBackend.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L211) +Defined in: [src/filters/WebGLFilterBackend.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L211) Create a WebGL texture object. @@ -319,7 +319,7 @@ This filter is very useful for LUTs filters. If you need interpolation use gl.LI > **createWebGLCanvas**(`width`, `height`): `void` -Defined in: [src/filters/WebGLFilterBackend.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L74) +Defined in: [src/filters/WebGLFilterBackend.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L74) Create a canvas element and associated WebGL context and attaches them as class properties to the GLFilterBackend class. @@ -344,7 +344,7 @@ class properties to the GLFilterBackend class. > **dispose**(): `void` -Defined in: [src/filters/WebGLFilterBackend.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L178) +Defined in: [src/filters/WebGLFilterBackend.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L178) Detach event listeners, remove references, and clean up caches. @@ -358,7 +358,7 @@ Detach event listeners, remove references, and clean up caches. > **evictCachesForKey**(`cacheKey`): `void` -Defined in: [src/filters/WebGLFilterBackend.ts:304](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L304) +Defined in: [src/filters/WebGLFilterBackend.ts:304](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L304) Clear out cached resources related to a source image that has been filtered previously. @@ -381,7 +381,7 @@ The cache key provided when the source image was filtered. > **getCachedTexture**(`uniqueId`, `textureImageSource`, `filter?`): `null` \| `WebGLTexture` -Defined in: [src/filters/WebGLFilterBackend.ts:273](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L273) +Defined in: [src/filters/WebGLFilterBackend.ts:273](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L273) Can be optionally used to get a texture from the cache array @@ -416,7 +416,7 @@ texture cache entry if one does not already exist. > **setupGLContext**(`width`, `height`): `void` -Defined in: [src/filters/WebGLFilterBackend.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/WebGLFilterBackend.ts#L65) +Defined in: [src/filters/WebGLFilterBackend.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/WebGLFilterBackend.ts#L65) Setup a WebGL context suitable for filtering, and bind any needed event handlers. diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createObjectDefaultControls.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createObjectDefaultControls.md index 3cc0119f..f2f47879 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createObjectDefaultControls.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createObjectDefaultControls.md @@ -7,7 +7,7 @@ title: "createObjectDefaultControls" > **createObjectDefaultControls**(): `object` -Defined in: [src/controls/commonControls.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/commonControls.ts#L14) +Defined in: [src/controls/commonControls.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/commonControls.ts#L14) ## Returns diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPathControls.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPathControls.md index b2db8f6d..128ce9d2 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPathControls.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPathControls.md @@ -7,7 +7,7 @@ title: "createPathControls" > **createPathControls**(`path`, `options`): `Record`\<`string`, [`Control`](/api/classes/control/)\> -Defined in: [src/controls/pathControl.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/pathControl.ts#L240) +Defined in: [src/controls/pathControl.ts:240](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/pathControl.ts#L240) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyActionHandler.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyActionHandler.md index 00800f99..a6b730ea 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyActionHandler.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyActionHandler.md @@ -7,7 +7,7 @@ title: "createPolyActionHandler" > **createPolyActionHandler**(`pointIndex`): [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<[`Transform`](/api/type-aliases/transform/)\> -Defined in: [src/controls/polyControl.ts:99](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/polyControl.ts#L99) +Defined in: [src/controls/polyControl.ts:99](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/polyControl.ts#L99) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyControls.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyControls.md index bc84c65a..b642a443 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyControls.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyControls.md @@ -9,7 +9,7 @@ title: "createPolyControls" > **createPolyControls**(`poly`, `options?`): `Record`\<`string`, [`Control`](/api/classes/control/)\> -Defined in: [src/controls/polyControl.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/polyControl.ts#L105) +Defined in: [src/controls/polyControl.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/polyControl.ts#L105) ### Parameters @@ -29,7 +29,7 @@ Defined in: [src/controls/polyControl.ts:105](https://github.com/fabricjs/fabric > **createPolyControls**(`numOfControls`, `options?`): `Record`\<`string`, [`Control`](/api/classes/control/)\> -Defined in: [src/controls/polyControl.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/polyControl.ts#L109) +Defined in: [src/controls/polyControl.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/polyControl.ts#L109) ### Parameters diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyPositionHandler.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyPositionHandler.md index 3a47b1a6..dd6ecfa6 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyPositionHandler.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createPolyPositionHandler.md @@ -7,7 +7,7 @@ title: "createPolyPositionHandler" > **createPolyPositionHandler**(`pointIndex`): (`dim`, `finalMatrix`, `polyObject`) => [`Point`](/api/classes/point/) -Defined in: [src/controls/polyControl.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/polyControl.ts#L24) +Defined in: [src/controls/polyControl.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/polyControl.ts#L24) This function locates the controls. It'll be used both for drawing and for interaction. diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createResizeControls.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createResizeControls.md index b982cab5..d272dd62 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createResizeControls.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createResizeControls.md @@ -7,7 +7,7 @@ title: "createResizeControls" > **createResizeControls**(): `object` -Defined in: [src/controls/commonControls.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/commonControls.ts#L86) +Defined in: [src/controls/commonControls.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/commonControls.ts#L86) ## Returns diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createTextboxDefaultControls.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createTextboxDefaultControls.md index 7c5d0a9b..fd0b8766 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createTextboxDefaultControls.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/createTextboxDefaultControls.md @@ -7,7 +7,7 @@ title: "createTextboxDefaultControls" > **createTextboxDefaultControls**(): `object` -Defined in: [src/controls/commonControls.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/commonControls.ts#L103) +Defined in: [src/controls/commonControls.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/commonControls.ts#L103) ## Returns diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/factoryPolyActionHandler.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/factoryPolyActionHandler.md index 972388d5..994b0c7b 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/factoryPolyActionHandler.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/factoryPolyActionHandler.md @@ -7,7 +7,7 @@ title: "factoryPolyActionHandler" > **factoryPolyActionHandler**(`pointIndex`, `fn`): (`eventData`, `transform`, `x`, `y`) => `boolean` -Defined in: [src/controls/polyControl.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/polyControl.ts#L68) +Defined in: [src/controls/polyControl.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/polyControl.ts#L68) Keep the polygon in the same position when we change its `width`/`height`/`top`/`left`. diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/getLocalPoint.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/getLocalPoint.md index 5828cb45..f7f4a3dc 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/getLocalPoint.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/getLocalPoint.md @@ -7,7 +7,7 @@ title: "getLocalPoint" > **getLocalPoint**(`transform`, `originX`, `originY`, `x`, `y`): [`Point`](/api/classes/point/) -Defined in: [src/controls/util.ts:136](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/util.ts#L136) +Defined in: [src/controls/util.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/util.ts#L136) Transforms a point to the offset from the given origin diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/polyActionHandler.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/polyActionHandler.md index 8bcb5c73..d91ae9f8 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/polyActionHandler.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/polyActionHandler.md @@ -7,7 +7,7 @@ title: "polyActionHandler" > **polyActionHandler**(`eventData`, `transform`, `x`, `y`): `boolean` -Defined in: [src/controls/polyControl.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/polyControl.ts#L45) +Defined in: [src/controls/polyControl.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/polyControl.ts#L45) This function defines what the control does. It'll be called on every mouse move after a control has been clicked and is being dragged. diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/renderCircleControl.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/renderCircleControl.md index dbc13593..ae3435b7 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/renderCircleControl.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/renderCircleControl.md @@ -7,7 +7,7 @@ title: "renderCircleControl" > **renderCircleControl**(`this`, `ctx`, `left`, `top`, `styleOverride`, `fabricObject`): `void` -Defined in: [src/controls/controlRendering.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/controlRendering.ts#L38) +Defined in: [src/controls/controlRendering.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/controlRendering.ts#L38) Render a round control, as per fabric features. This function is written to respect object properties like transparentCorners, cornerSize diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/renderSquareControl.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/renderSquareControl.md index 1699ab6e..86898c95 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/renderSquareControl.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/renderSquareControl.md @@ -7,7 +7,7 @@ title: "renderSquareControl" > **renderSquareControl**(`this`, `ctx`, `left`, `top`, `styleOverride`, `fabricObject`): `void` -Defined in: [src/controls/controlRendering.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/controlRendering.ts#L82) +Defined in: [src/controls/controlRendering.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/controlRendering.ts#L82) Render a square control, as per fabric features. This function is written to respect object properties like transparentCorners, cornerSize diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/wrapWithFireEvent.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/wrapWithFireEvent.md index 7a01280b..f3da3387 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/wrapWithFireEvent.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/wrapWithFireEvent.md @@ -7,7 +7,7 @@ title: "wrapWithFireEvent" > **wrapWithFireEvent**\<`T`, `P`\>(`eventName`, `actionHandler`, `extraEventInfo?`): [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<`T`\> -Defined in: [src/controls/wrapWithFireEvent.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/wrapWithFireEvent.ts#L16) +Defined in: [src/controls/wrapWithFireEvent.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/wrapWithFireEvent.ts#L16) Wrap an action handler with firing an event if the action is performed diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/wrapWithFixedAnchor.md b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/wrapWithFixedAnchor.md index 82db039a..59b42b25 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/functions/wrapWithFixedAnchor.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/functions/wrapWithFixedAnchor.md @@ -7,7 +7,7 @@ title: "wrapWithFixedAnchor" > **wrapWithFixedAnchor**\<`T`\>(`actionHandler`): [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<`T`\> -Defined in: [src/controls/wrapWithFixedAnchor.ts:9](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/wrapWithFixedAnchor.ts#L9) +Defined in: [src/controls/wrapWithFixedAnchor.ts:9](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/wrapWithFixedAnchor.ts#L9) Wrap an action handler with saving/restoring object position on the transform. this is the code that permits to objects to keep their position while transforming. diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/type-aliases/PathPointControlStyle.md b/src/content/docs/api/fabric/namespaces/controlsUtils/type-aliases/PathPointControlStyle.md index b673face..3bd2ea20 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/type-aliases/PathPointControlStyle.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/type-aliases/PathPointControlStyle.md @@ -7,7 +7,7 @@ title: "PathPointControlStyle" > **PathPointControlStyle** = `object` -Defined in: [src/controls/pathControl.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/pathControl.ts#L21) +Defined in: [src/controls/pathControl.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/pathControl.ts#L21) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/controls/pathControl.ts:21](https://github.com/fabricjs/fabric. > `optional` **connectionDashArray**: `number`[] -Defined in: [src/controls/pathControl.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/pathControl.ts#L24) +Defined in: [src/controls/pathControl.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/pathControl.ts#L24) *** @@ -23,7 +23,7 @@ Defined in: [src/controls/pathControl.ts:24](https://github.com/fabricjs/fabric. > `optional` **controlFill**: `string` -Defined in: [src/controls/pathControl.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/pathControl.ts#L22) +Defined in: [src/controls/pathControl.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/pathControl.ts#L22) *** @@ -31,4 +31,4 @@ Defined in: [src/controls/pathControl.ts:22](https://github.com/fabricjs/fabric. > `optional` **controlStroke**: `string` -Defined in: [src/controls/pathControl.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/pathControl.ts#L23) +Defined in: [src/controls/pathControl.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/pathControl.ts#L23) diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeHeight.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeHeight.md new file mode 100644 index 00000000..1cfa8855 --- /dev/null +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeHeight.md @@ -0,0 +1,12 @@ +--- +editUrl: false +next: false +prev: false +title: "changeHeight" +--- + +> `const` **changeHeight**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<[`Transform`](/api/type-aliases/transform/)\> + +Defined in: [src/controls/changeWidth.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/changeWidth.ts#L85) + +Control handler for changing height diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeObjectHeight.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeObjectHeight.md new file mode 100644 index 00000000..47c49419 --- /dev/null +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeObjectHeight.md @@ -0,0 +1,35 @@ +--- +editUrl: false +next: false +prev: false +title: "changeObjectHeight" +--- + +> `const` **changeObjectHeight**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/) + +Defined in: [src/controls/changeWidth.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/changeWidth.ts#L71) + +Action handler to change object's height +Needs to be wrapped with `wrapWithFixedAnchor` to be effective +You want to use this only if you are building a new control handler and you want +to reuse some logic. use "changeHeight" if you are looking to just use a control for height + +## Param + +javascript event that is doing the transform + +## Param + +javascript object containing a series of information around the current transform + +## Param + +current mouse x position, canvas normalized + +## Param + +current mouse y position, canvas normalized + +## Returns + +true if some change happened diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeObjectWidth.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeObjectWidth.md new file mode 100644 index 00000000..84ba552b --- /dev/null +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeObjectWidth.md @@ -0,0 +1,35 @@ +--- +editUrl: false +next: false +prev: false +title: "changeObjectWidth" +--- + +> `const` **changeObjectWidth**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/) + +Defined in: [src/controls/changeWidth.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/changeWidth.ts#L57) + +Action handler to change object's width +Needs to be wrapped with `wrapWithFixedAnchor` to be effective +You want to use this only if you are building a new control handler and you want +to reuse some logic. use "changeWidth" if you are looking to just use a control for width + +## Param + +javascript event that is doing the transform + +## Param + +javascript object containing a series of information around the current transform + +## Param + +current mouse x position, canvas normalized + +## Param + +current mouse y position, canvas normalized + +## Returns + +true if some change happened diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeWidth.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeWidth.md index 66a6b71d..1cd08925 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeWidth.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/changeWidth.md @@ -7,6 +7,6 @@ title: "changeWidth" > `const` **changeWidth**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<[`Transform`](/api/type-aliases/transform/)\> -Defined in: [src/controls/changeWidth.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/changeWidth.ts#L77) +Defined in: [src/controls/changeWidth.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/changeWidth.ts#L77) Control handler for changing width diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/rotationStyleHandler.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/rotationStyleHandler.md index 8bd1029e..5948f89e 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/rotationStyleHandler.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/rotationStyleHandler.md @@ -7,7 +7,7 @@ title: "rotationStyleHandler" > `const` **rotationStyleHandler**: [`ControlCursorCallback`](/api/type-aliases/controlcursorcallback/) -Defined in: [src/controls/rotate.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/rotate.ts#L19) +Defined in: [src/controls/rotate.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/rotate.ts#L19) Find the correct style for the control that is used for rotation. this function is very simple and it just take care of not-allowed or standard cursor diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/rotationWithSnapping.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/rotationWithSnapping.md index 6adec1eb..3ac88d5b 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/rotationWithSnapping.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/rotationWithSnapping.md @@ -7,4 +7,4 @@ title: "rotationWithSnapping" > `const` **rotationWithSnapping**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<[`Transform`](/api/type-aliases/transform/)\> -Defined in: [src/controls/rotate.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/rotate.ts#L81) +Defined in: [src/controls/rotate.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/rotate.ts#L81) diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleCursorStyleHandler.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleCursorStyleHandler.md index 287e39a6..61a0c6f6 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleCursorStyleHandler.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleCursorStyleHandler.md @@ -7,7 +7,7 @@ title: "scaleCursorStyleHandler" > `const` **scaleCursorStyleHandler**: [`ControlCursorCallback`](/api/type-aliases/controlcursorcallback/) -Defined in: [src/controls/scale.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/scale.ts#L95) +Defined in: [src/controls/scale.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/scale.ts#L95) return the correct cursor style for the scale action diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleOrSkewActionName.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleOrSkewActionName.md index cf9dd7dc..627af939 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleOrSkewActionName.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleOrSkewActionName.md @@ -7,7 +7,7 @@ title: "scaleOrSkewActionName" > `const` **scaleOrSkewActionName**: [`ControlCallback`](/api/type-aliases/controlcallback/)\<[`TAxisKey`](/api/type-aliases/taxiskey/)\<`"skew"` \| `"scale"`\> \| `""`\> -Defined in: [src/controls/scaleSkew.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/scaleSkew.ts#L24) +Defined in: [src/controls/scaleSkew.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/scaleSkew.ts#L24) Inspect event, control and fabricObject to return the correct action name diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleSkewCursorStyleHandler.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleSkewCursorStyleHandler.md index 019e2753..74de4e5d 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleSkewCursorStyleHandler.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scaleSkewCursorStyleHandler.md @@ -7,7 +7,7 @@ title: "scaleSkewCursorStyleHandler" > `const` **scaleSkewCursorStyleHandler**: [`ControlCursorCallback`](/api/type-aliases/controlcursorcallback/) -Defined in: [src/controls/scaleSkew.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/scaleSkew.ts#L46) +Defined in: [src/controls/scaleSkew.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/scaleSkew.ts#L46) Combine skew and scale style handlers to cover fabric standard use case diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingEqually.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingEqually.md index 4485b3eb..75c6cada 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingEqually.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingEqually.md @@ -5,6 +5,6 @@ prev: false title: "scalingEqually" --- -> `const` **scalingEqually**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<`ScaleTransform`\> +> `const` **scalingEqually**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<[`Transform`](/api/type-aliases/transform/)\> -Defined in: [src/controls/scale.ts:275](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/scale.ts#L275) +Defined in: [src/controls/scale.ts:265](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/scale.ts#L265) diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingX.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingX.md index f4d056ca..a4f18ca0 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingX.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingX.md @@ -5,6 +5,6 @@ prev: false title: "scalingX" --- -> `const` **scalingX**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<`ScaleTransform`\> +> `const` **scalingX**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<[`Transform`](/api/type-aliases/transform/)\> -Defined in: [src/controls/scale.ts:280](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/scale.ts#L280) +Defined in: [src/controls/scale.ts:270](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/scale.ts#L270) diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingXOrSkewingY.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingXOrSkewingY.md index 4900c721..25d7783f 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingXOrSkewingY.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingXOrSkewingY.md @@ -7,7 +7,7 @@ title: "scalingXOrSkewingY" > `const` **scalingXOrSkewingY**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/) -Defined in: [src/controls/scaleSkew.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/scaleSkew.ts#L65) +Defined in: [src/controls/scaleSkew.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/scaleSkew.ts#L65) Composed action handler to either scale X or skew Y Needs to be wrapped with `wrapWithFixedAnchor` to be effective diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingY.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingY.md index 323549eb..060bb92d 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingY.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingY.md @@ -5,6 +5,6 @@ prev: false title: "scalingY" --- -> `const` **scalingY**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<`ScaleTransform`\> +> `const` **scalingY**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/)\<[`Transform`](/api/type-aliases/transform/)\> -Defined in: [src/controls/scale.ts:285](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/scale.ts#L285) +Defined in: [src/controls/scale.ts:275](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/scale.ts#L275) diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingYOrSkewingX.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingYOrSkewingX.md index 39a51b47..7881697b 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingYOrSkewingX.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/scalingYOrSkewingX.md @@ -7,7 +7,7 @@ title: "scalingYOrSkewingX" > `const` **scalingYOrSkewingX**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/) -Defined in: [src/controls/scaleSkew.ts:85](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/scaleSkew.ts#L85) +Defined in: [src/controls/scaleSkew.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/scaleSkew.ts#L85) Composed action handler to either scale Y or skew X Needs to be wrapped with `wrapWithFixedAnchor` to be effective diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewCursorStyleHandler.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewCursorStyleHandler.md index cc09ff3c..f0d860d3 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewCursorStyleHandler.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewCursorStyleHandler.md @@ -7,7 +7,7 @@ title: "skewCursorStyleHandler" > `const` **skewCursorStyleHandler**: [`ControlCursorCallback`](/api/type-aliases/controlcursorcallback/) -Defined in: [src/controls/skew.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/skew.ts#L71) +Defined in: [src/controls/skew.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/skew.ts#L71) return the correct cursor style for the skew action diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewHandlerX.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewHandlerX.md index c24b50e3..c3d39b57 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewHandlerX.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewHandlerX.md @@ -7,7 +7,7 @@ title: "skewHandlerX" > `const` **skewHandlerX**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/) -Defined in: [src/controls/skew.ts:226](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/skew.ts#L226) +Defined in: [src/controls/skew.ts:226](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/skew.ts#L226) Wrapped Action handler for skewing on the X axis, takes care of the skew direction and determines the correct transform origin for the anchor point diff --git a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewHandlerY.md b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewHandlerY.md index 7dab6674..ddec12c8 100644 --- a/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewHandlerY.md +++ b/src/content/docs/api/fabric/namespaces/controlsUtils/variables/skewHandlerY.md @@ -7,7 +7,7 @@ title: "skewHandlerY" > `const` **skewHandlerY**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/) -Defined in: [src/controls/skew.ts:244](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/controls/skew.ts#L244) +Defined in: [src/controls/skew.ts:244](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/skew.ts#L244) Wrapped Action handler for skewing on the Y axis, takes care of the skew direction and determines the correct transform origin for the anchor point diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/BaseFilter.md b/src/content/docs/api/fabric/namespaces/filters/classes/BaseFilter.md index 3a72a268..e0dde291 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/BaseFilter.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/BaseFilter.md @@ -5,7 +5,7 @@ prev: false title: "BaseFilter" --- -Defined in: [src/filters/BaseFilter.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L21) +Defined in: [src/filters/BaseFilter.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L21) ## Extended by @@ -47,7 +47,7 @@ Defined in: [src/filters/BaseFilter.ts:21](https://github.com/fabricjs/fabric.js > **new BaseFilter**\<`Name`, `OwnProps`, `SerializedProps`\>(`options?`): `BaseFilter`\<`Name`, `OwnProps`, `SerializedProps`\> -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -69,7 +69,7 @@ Options object > `static` **defaults**: `Record`\<`string`, `unknown`\> -Defined in: [src/filters/BaseFilter.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L49) +Defined in: [src/filters/BaseFilter.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L49) *** @@ -77,7 +77,7 @@ Defined in: [src/filters/BaseFilter.ts:49](https://github.com/fabricjs/fabric.js > `static` **type**: `string` = `'BaseFilter'` -Defined in: [src/filters/BaseFilter.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L40) +Defined in: [src/filters/BaseFilter.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L40) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -91,7 +91,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] = `[]` -Defined in: [src/filters/BaseFilter.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L47) +Defined in: [src/filters/BaseFilter.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L47) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -105,7 +105,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -119,7 +119,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -137,7 +137,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -155,7 +155,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -177,7 +177,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`_options`): `void` -Defined in: [src/filters/BaseFilter.ts:273](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L273) +Defined in: [src/filters/BaseFilter.ts:273](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L273) #### Parameters @@ -195,7 +195,7 @@ Defined in: [src/filters/BaseFilter.ts:273](https://github.com/fabricjs/fabric.j > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -215,7 +215,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -241,7 +241,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -262,7 +262,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -308,7 +308,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -338,7 +338,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -353,7 +353,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -383,7 +383,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -395,7 +395,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(`options?`): `boolean` -Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L246) +Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L246) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -418,7 +418,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -440,7 +440,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -472,7 +472,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`_gl`, `_uniformLocations`): `void` -Defined in: [src/filters/BaseFilter.ts:357](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L357) +Defined in: [src/filters/BaseFilter.ts:357](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L357) Send uniform data from this filter to its shader program on the GPU. @@ -502,7 +502,7 @@ A map of shader uniform names to their locations. > **toJSON**(): `object` & `SerializedProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -518,7 +518,7 @@ JSON > **toObject**(): `object` & `SerializedProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -536,7 +536,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -558,7 +558,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<`BaseFilter`\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/BlendColor.md b/src/content/docs/api/fabric/namespaces/filters/classes/BlendColor.md index 46ceeca2..6ded21a0 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/BlendColor.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/BlendColor.md @@ -5,7 +5,7 @@ prev: false title: "BlendColor" --- -Defined in: [src/filters/BlendColor.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L47) +Defined in: [src/filters/BlendColor.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L47) Color Blend filter class @@ -36,7 +36,7 @@ canvas.renderAll(); > **new BlendColor**(`options?`): `BlendColor` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -62,7 +62,7 @@ Options object > **alpha**: `number` -Defined in: [src/filters/BlendColor.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L65) +Defined in: [src/filters/BlendColor.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L65) alpha value. represent the strength of the blend color operation. @@ -72,7 +72,7 @@ alpha value. represent the strength of the blend color operation. > **color**: `string` -Defined in: [src/filters/BlendColor.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L53) +Defined in: [src/filters/BlendColor.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L53) Color to make the blend operation with. default to a reddish color since black or white gives always strong result. @@ -83,7 +83,7 @@ gives always strong result. > **mode**: [`TBlendMode`](/api/fabric/namespaces/filters/type-aliases/tblendmode/) -Defined in: [src/filters/BlendColor.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L60) +Defined in: [src/filters/BlendColor.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L60) Blend mode for the filter: one of multiply, add, difference, screen, subtract, darken, lighten, overlay, exclusion, tint. @@ -94,7 +94,7 @@ darken, lighten, overlay, exclusion, tint. > `static` **defaults**: `BlendColorOwnProps` = `blendColorDefaultValues` -Defined in: [src/filters/BlendColor.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L67) +Defined in: [src/filters/BlendColor.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L67) #### Overrides @@ -106,7 +106,7 @@ Defined in: [src/filters/BlendColor.ts:67](https://github.com/fabricjs/fabric.js > `static` **type**: `string` = `'BlendColor'` -Defined in: [src/filters/BlendColor.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L69) +Defined in: [src/filters/BlendColor.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L69) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -124,7 +124,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/BlendColor.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L71) +Defined in: [src/filters/BlendColor.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L71) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -142,7 +142,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -160,7 +160,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -182,7 +182,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -204,7 +204,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -230,7 +230,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/BlendColor.ts:99](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L99) +Defined in: [src/filters/BlendColor.ts:99](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L99) Apply the Blend operation to a Uint8ClampedArray representing the pixels of an image. @@ -254,7 +254,7 @@ Apply the Blend operation to a Uint8ClampedArray representing the pixels of an i > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -278,7 +278,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -308,7 +308,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -333,7 +333,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -383,7 +383,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -417,7 +417,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BlendColor.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L73) +Defined in: [src/filters/BlendColor.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L73) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -436,7 +436,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -470,7 +470,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -486,7 +486,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(`options?`): `boolean` -Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L246) +Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L246) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -513,7 +513,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -539,7 +539,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -575,7 +575,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/BlendColor.ts:184](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L184) +Defined in: [src/filters/BlendColor.ts:184](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L184) Send data from this filter to its shader program's uniforms. @@ -607,7 +607,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `BlendColorOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -627,7 +627,7 @@ JSON > **toObject**(): `object` & `BlendColorOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -649,7 +649,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -675,7 +675,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/BlendImage.md b/src/content/docs/api/fabric/namespaces/filters/classes/BlendImage.md index 68c79cb2..50ed5b88 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/BlendImage.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/BlendImage.md @@ -5,7 +5,7 @@ prev: false title: "BlendImage" --- -Defined in: [src/filters/BlendImage.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L41) +Defined in: [src/filters/BlendImage.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L41) Image Blend filter class @@ -36,7 +36,7 @@ canvas.renderAll(); > **new BlendImage**(`options?`): `BlendImage` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -62,7 +62,7 @@ Options object > **alpha**: `number` -Defined in: [src/filters/BlendImage.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L61) +Defined in: [src/filters/BlendImage.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L61) alpha value. represent the strength of the blend image operation. not implemented. @@ -73,7 +73,7 @@ not implemented. > **image**: [`FabricImage`](/api/classes/fabricimage/) -Defined in: [src/filters/BlendImage.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L45) +Defined in: [src/filters/BlendImage.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L45) Image to make the blend operation with. @@ -83,7 +83,7 @@ Image to make the blend operation with. > **mode**: `TBlendImageMode` -Defined in: [src/filters/BlendImage.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L55) +Defined in: [src/filters/BlendImage.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L55) Blend mode for the filter: either 'multiply' or 'mask'. 'multiply' will multiply the values of each channel (R, G, B, and A) of the filter image by @@ -97,7 +97,7 @@ image's alpha channel. > `static` **defaults**: `BlendImageOwnProps` = `blendImageDefaultValues` -Defined in: [src/filters/BlendImage.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L65) +Defined in: [src/filters/BlendImage.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L65) #### Overrides @@ -109,7 +109,7 @@ Defined in: [src/filters/BlendImage.ts:65](https://github.com/fabricjs/fabric.js > `static` **type**: `string` = `'BlendImage'` -Defined in: [src/filters/BlendImage.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L63) +Defined in: [src/filters/BlendImage.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L63) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -127,7 +127,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/BlendImage.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L67) +Defined in: [src/filters/BlendImage.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L67) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -145,7 +145,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -163,7 +163,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -185,7 +185,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -207,7 +207,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -233,7 +233,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/BlendImage.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L121) +Defined in: [src/filters/BlendImage.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L121) Apply the Blend operation to a Uint8ClampedArray representing the pixels of an image. @@ -257,7 +257,7 @@ Apply the Blend operation to a Uint8ClampedArray representing the pixels of an i > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BlendImage.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L81) +Defined in: [src/filters/BlendImage.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L81) Apply this filter using webgl. @@ -281,7 +281,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -311,7 +311,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **calculateMatrix**(): `number`[] -Defined in: [src/filters/BlendImage.ts:99](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L99) +Defined in: [src/filters/BlendImage.ts:99](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L99) Calculate a transformMatrix to adapt the image to blend over @@ -325,7 +325,7 @@ Calculate a transformMatrix to adapt the image to blend over > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -350,7 +350,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -400,7 +400,7 @@ vertexShader source for compilation > **createTexture**(`backend`, `image`): `null` \| `WebGLTexture` -Defined in: [src/filters/BlendImage.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L89) +Defined in: [src/filters/BlendImage.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L89) #### Parameters @@ -422,7 +422,7 @@ Defined in: [src/filters/BlendImage.ts:89](https://github.com/fabricjs/fabric.js > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -456,7 +456,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BlendImage.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L69) +Defined in: [src/filters/BlendImage.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L69) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -475,7 +475,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/BlendImage.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L73) +Defined in: [src/filters/BlendImage.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L73) #### Returns @@ -491,7 +491,7 @@ Defined in: [src/filters/BlendImage.ts:73](https://github.com/fabricjs/fabric.js > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -525,7 +525,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BlendImage.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L77) +Defined in: [src/filters/BlendImage.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L77) #### Returns @@ -541,7 +541,7 @@ Defined in: [src/filters/BlendImage.ts:77](https://github.com/fabricjs/fabric.js > **isNeutralState**(`options?`): `boolean` -Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L246) +Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L246) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -568,7 +568,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -594,7 +594,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -630,7 +630,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/BlendImage.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L178) +Defined in: [src/filters/BlendImage.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L178) Send data from this filter to its shader program's uniforms. @@ -662,7 +662,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `BlendImageOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -682,7 +682,7 @@ JSON > **toObject**(): `object` & `BlendImageOwnProps` -Defined in: [src/filters/BlendImage.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L193) +Defined in: [src/filters/BlendImage.ts:193](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L193) Returns object representation of an instance TODO: Handle the possibility of missing image better. @@ -704,7 +704,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -730,7 +730,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`object`, `options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`"BlendImage"`, `BlendImageOwnProps`, `BlendImageOwnProps`\>\> -Defined in: [src/filters/BlendImage.ts:210](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendImage.ts#L210) +Defined in: [src/filters/BlendImage.ts:210](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendImage.ts#L210) Create filter instance from an object representation diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Blur.md b/src/content/docs/api/fabric/namespaces/filters/classes/Blur.md index 09ab9c21..eb7aff8a 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Blur.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Blur.md @@ -5,7 +5,7 @@ prev: false title: "Blur" --- -Defined in: [src/filters/Blur.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L29) +Defined in: [src/filters/Blur.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L29) Blur filter class @@ -30,7 +30,7 @@ canvas.renderAll(); > **new Blur**(`options?`): `Blur` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -56,7 +56,7 @@ Options object > **aspectRatio**: `number` -Defined in: [src/filters/Blur.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L39) +Defined in: [src/filters/Blur.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L39) *** @@ -64,7 +64,7 @@ Defined in: [src/filters/Blur.ts:39](https://github.com/fabricjs/fabric.js/blob/ > **blur**: `number` -Defined in: [src/filters/Blur.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L36) +Defined in: [src/filters/Blur.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L36) blur value, in percentage of image dimensions. specific to keep the image blur constant at different resolutions @@ -76,7 +76,7 @@ range between 0 and 1. > **horizontal**: `boolean` -Defined in: [src/filters/Blur.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L38) +Defined in: [src/filters/Blur.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L38) *** @@ -84,7 +84,7 @@ Defined in: [src/filters/Blur.ts:38](https://github.com/fabricjs/fabric.js/blob/ > `static` **defaults**: `BlurOwnProps` = `blurDefaultValues` -Defined in: [src/filters/Blur.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L43) +Defined in: [src/filters/Blur.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L43) #### Overrides @@ -96,7 +96,7 @@ Defined in: [src/filters/Blur.ts:43](https://github.com/fabricjs/fabric.js/blob/ > `static` **type**: `string` = `'Blur'` -Defined in: [src/filters/Blur.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L41) +Defined in: [src/filters/Blur.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L41) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -114,7 +114,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Blur.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L45) +Defined in: [src/filters/Blur.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L45) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -132,7 +132,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -150,7 +150,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -172,7 +172,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -194,7 +194,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/Blur.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L51) +Defined in: [src/filters/Blur.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L51) Apply this filter to the input image data provided. @@ -220,7 +220,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`__namedParameters`): `void` -Defined in: [src/filters/Blur.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L69) +Defined in: [src/filters/Blur.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L69) #### Parameters @@ -242,7 +242,7 @@ Defined in: [src/filters/Blur.ts:69](https://github.com/fabricjs/fabric.js/blob/ > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -266,7 +266,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -296,7 +296,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **chooseRightDelta**(): `number`[] -Defined in: [src/filters/Blur.ts:199](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L199) +Defined in: [src/filters/Blur.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L199) choose right value of image percentage to blur with @@ -312,7 +312,7 @@ a numeric array with delta values > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -337,7 +337,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -387,7 +387,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -421,7 +421,7 @@ A map of attribute names to attribute locations. > **getBlurValue**(): `number` -Defined in: [src/filters/Blur.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L178) +Defined in: [src/filters/Blur.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L178) #### Returns @@ -433,7 +433,7 @@ Defined in: [src/filters/Blur.ts:178](https://github.com/fabricjs/fabric.js/blob > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -452,7 +452,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/Blur.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L47) +Defined in: [src/filters/Blur.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L47) #### Returns @@ -468,7 +468,7 @@ Defined in: [src/filters/Blur.ts:47](https://github.com/fabricjs/fabric.js/blob/ > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -502,7 +502,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -518,7 +518,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Blur.ts:174](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L174) +Defined in: [src/filters/Blur.ts:174](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L174) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -539,7 +539,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -565,7 +565,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -601,7 +601,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Blur.ts:166](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Blur.ts#L166) +Defined in: [src/filters/Blur.ts:166](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Blur.ts#L166) Send data from this filter to its shader program's uniforms. @@ -633,7 +633,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `BlurOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -653,7 +653,7 @@ JSON > **toObject**(): `object` & `BlurOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -675,7 +675,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -701,7 +701,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Brightness.md b/src/content/docs/api/fabric/namespaces/filters/classes/Brightness.md index 03f72fcf..221496a5 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Brightness.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Brightness.md @@ -5,7 +5,7 @@ prev: false title: "Brightness" --- -Defined in: [src/filters/Brightness.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Brightness.ts#L23) +Defined in: [src/filters/Brightness.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Brightness.ts#L23) Brightness filter class @@ -29,7 +29,7 @@ object.applyFilters(); > **new Brightness**(`options?`): `Brightness` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -55,7 +55,7 @@ Options object > **brightness**: `number` -Defined in: [src/filters/Brightness.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Brightness.ts#L30) +Defined in: [src/filters/Brightness.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Brightness.ts#L30) Brightness value, from -1 to 1. translated to -255 to 255 for 2d @@ -69,7 +69,7 @@ translated to -255 to 255 for 2d > `static` **defaults**: `BrightnessOwnProps` = `brightnessDefaultValues` -Defined in: [src/filters/Brightness.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Brightness.ts#L34) +Defined in: [src/filters/Brightness.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Brightness.ts#L34) #### Overrides @@ -81,7 +81,7 @@ Defined in: [src/filters/Brightness.ts:34](https://github.com/fabricjs/fabric.js > `static` **type**: `string` = `'Brightness'` -Defined in: [src/filters/Brightness.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Brightness.ts#L32) +Defined in: [src/filters/Brightness.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Brightness.ts#L32) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -99,7 +99,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Brightness.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Brightness.ts#L36) +Defined in: [src/filters/Brightness.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Brightness.ts#L36) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -117,7 +117,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -135,7 +135,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -157,7 +157,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -179,7 +179,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -205,7 +205,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Brightness.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Brightness.ts#L48) +Defined in: [src/filters/Brightness.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Brightness.ts#L48) Apply the Brightness operation to a Uint8ClampedArray representing the pixels of an image. @@ -229,7 +229,7 @@ Apply the Brightness operation to a Uint8ClampedArray representing the pixels of > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -253,7 +253,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -283,7 +283,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -308,7 +308,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -358,7 +358,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -392,7 +392,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -411,7 +411,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/Brightness.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Brightness.ts#L38) +Defined in: [src/filters/Brightness.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Brightness.ts#L38) #### Returns @@ -427,7 +427,7 @@ Defined in: [src/filters/Brightness.ts:38](https://github.com/fabricjs/fabric.js > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -461,7 +461,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -477,7 +477,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Brightness.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Brightness.ts#L57) +Defined in: [src/filters/Brightness.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Brightness.ts#L57) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -498,7 +498,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -524,7 +524,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -560,7 +560,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Brightness.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Brightness.ts#L67) +Defined in: [src/filters/Brightness.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Brightness.ts#L67) Send data from this filter to its shader program's uniforms. @@ -592,7 +592,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `BrightnessOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -612,7 +612,7 @@ JSON > **toObject**(): `object` & `BrightnessOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -634,7 +634,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -660,7 +660,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/ColorMatrix.md b/src/content/docs/api/fabric/namespaces/filters/classes/ColorMatrix.md index 3e99a298..6a8e82f8 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/ColorMatrix.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/ColorMatrix.md @@ -5,7 +5,7 @@ prev: false title: "ColorMatrix" --- -Defined in: [src/filters/ColorMatrix.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L36) +Defined in: [src/filters/ColorMatrix.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L36) Color Matrix filter class @@ -57,7 +57,7 @@ object.applyFilters(); > **new ColorMatrix**\<`Name`, `OwnProps`, `SerializedProps`\>(`options?`): `ColorMatrix`\<`Name`, `OwnProps`, `SerializedProps`\> -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -83,7 +83,7 @@ Options object > **colorsOnly**: `boolean` -Defined in: [src/filters/ColorMatrix.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L56) +Defined in: [src/filters/ColorMatrix.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L56) Lock the colormatrix on the color part, skipping alpha, mainly for non webgl scenario to save some calculation @@ -100,7 +100,7 @@ true > **matrix**: [`TMatColorMatrix`](/api/type-aliases/tmatcolormatrix/) -Defined in: [src/filters/ColorMatrix.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L48) +Defined in: [src/filters/ColorMatrix.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L48) Colormatrix for pixels. array of 20 floats. Numbers in positions 4, 9, 14, 19 loose meaning @@ -117,7 +117,7 @@ array of 20 numbers. > `static` **defaults**: `ColorMatrixOwnProps` = `colorMatrixDefaultValues` -Defined in: [src/filters/ColorMatrix.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L60) +Defined in: [src/filters/ColorMatrix.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L60) #### Overrides @@ -129,7 +129,7 @@ Defined in: [src/filters/ColorMatrix.ts:60](https://github.com/fabricjs/fabric.j > `static` **type**: `string` = `'ColorMatrix'` -Defined in: [src/filters/ColorMatrix.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L58) +Defined in: [src/filters/ColorMatrix.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L58) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -147,7 +147,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/ColorMatrix.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L62) +Defined in: [src/filters/ColorMatrix.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L62) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -165,7 +165,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -183,7 +183,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -205,7 +205,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -227,7 +227,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -253,7 +253,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/ColorMatrix.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L74) +Defined in: [src/filters/ColorMatrix.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L74) Apply the ColorMatrix operation to a Uint8Array representing the pixels of an image. @@ -277,7 +277,7 @@ Apply the ColorMatrix operation to a Uint8Array representing the pixels of an im > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -301,7 +301,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -331,7 +331,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -356,7 +356,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -406,7 +406,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -440,7 +440,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -459,7 +459,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/ColorMatrix.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L64) +Defined in: [src/filters/ColorMatrix.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L64) #### Returns @@ -475,7 +475,7 @@ Defined in: [src/filters/ColorMatrix.ts:64](https://github.com/fabricjs/fabric.j > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -509,7 +509,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -525,7 +525,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(`options?`): `boolean` -Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L246) +Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L246) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -552,7 +552,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -578,7 +578,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -614,7 +614,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/ColorMatrix.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L105) +Defined in: [src/filters/ColorMatrix.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L105) Send data from this filter to its shader program's uniforms. @@ -646,7 +646,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `SerializedProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -666,7 +666,7 @@ JSON > **toObject**(): `object` & `SerializedProps` -Defined in: [src/filters/ColorMatrix.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L133) +Defined in: [src/filters/ColorMatrix.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L133) Returns object representation of an instance It will automatically export the default values of a filter, @@ -688,7 +688,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -714,7 +714,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Composed.md b/src/content/docs/api/fabric/namespaces/filters/classes/Composed.md index daecdf35..61bb8cf8 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Composed.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Composed.md @@ -5,7 +5,7 @@ prev: false title: "Composed" --- -Defined in: [src/filters/Composed.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Composed.ts#L17) +Defined in: [src/filters/Composed.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Composed.ts#L17) A container class that knows how to apply a sequence of filters to an input image. @@ -19,7 +19,7 @@ A container class that knows how to apply a sequence of filters to an input imag > **new Composed**(`options`): `Composed` -Defined in: [src/filters/Composed.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Composed.ts#L29) +Defined in: [src/filters/Composed.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Composed.ts#L29) #### Parameters @@ -41,7 +41,7 @@ Defined in: [src/filters/Composed.ts:29](https://github.com/fabricjs/fabric.js/b > **subFilters**: [`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>[] -Defined in: [src/filters/Composed.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Composed.ts#L25) +Defined in: [src/filters/Composed.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Composed.ts#L25) A non sparse array of filters to apply @@ -51,7 +51,7 @@ A non sparse array of filters to apply > `static` **defaults**: `Record`\<`string`, `unknown`\> -Defined in: [src/filters/BaseFilter.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L49) +Defined in: [src/filters/BaseFilter.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L49) #### Inherited from @@ -63,7 +63,7 @@ Defined in: [src/filters/BaseFilter.ts:49](https://github.com/fabricjs/fabric.js > `static` **type**: `string` = `'Composed'` -Defined in: [src/filters/Composed.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Composed.ts#L27) +Defined in: [src/filters/Composed.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Composed.ts#L27) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -81,7 +81,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] = `[]` -Defined in: [src/filters/BaseFilter.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L47) +Defined in: [src/filters/BaseFilter.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L47) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -99,7 +99,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -117,7 +117,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -139,7 +139,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -161,7 +161,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/Composed.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Composed.ts#L42) +Defined in: [src/filters/Composed.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Composed.ts#L42) Apply this container's filters to the input image provided. @@ -185,7 +185,7 @@ Apply this container's filters to the input image provided. > **applyTo2d**(`_options`): `void` -Defined in: [src/filters/BaseFilter.ts:273](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L273) +Defined in: [src/filters/BaseFilter.ts:273](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L273) #### Parameters @@ -207,7 +207,7 @@ Defined in: [src/filters/BaseFilter.ts:273](https://github.com/fabricjs/fabric.j > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -231,7 +231,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -261,7 +261,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -286,7 +286,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -336,7 +336,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -370,7 +370,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -389,7 +389,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -423,7 +423,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -439,7 +439,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Composed.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Composed.ts#L62) +Defined in: [src/filters/Composed.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Composed.ts#L62) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -460,7 +460,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -486,7 +486,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -522,7 +522,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`_gl`, `_uniformLocations`): `void` -Defined in: [src/filters/BaseFilter.ts:357](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L357) +Defined in: [src/filters/BaseFilter.ts:357](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L357) Send uniform data from this filter to its shader program on the GPU. @@ -556,7 +556,7 @@ A map of shader uniform names to their locations. > **toJSON**(): `object` & `ComposedSerializedProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -576,7 +576,7 @@ JSON > **toObject**(): `object` -Defined in: [src/filters/Composed.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Composed.ts#L55) +Defined in: [src/filters/Composed.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Composed.ts#L55) Serialize this filter into JSON. @@ -604,7 +604,7 @@ A JSON representation of this filter. > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -630,7 +630,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`object`, `options?`): `Promise`\<`Composed`\> -Defined in: [src/filters/Composed.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Composed.ts#L73) +Defined in: [src/filters/Composed.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Composed.ts#L73) Deserialize a JSON definition of a ComposedFilter into a concrete instance. diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Contrast.md b/src/content/docs/api/fabric/namespaces/filters/classes/Contrast.md index f48f29ba..6d2e6b03 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Contrast.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Contrast.md @@ -5,7 +5,7 @@ prev: false title: "Contrast" --- -Defined in: [src/filters/Contrast.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Contrast.ts#L23) +Defined in: [src/filters/Contrast.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Contrast.ts#L23) Contrast filter class @@ -29,7 +29,7 @@ object.applyFilters(); > **new Contrast**(`options?`): `Contrast` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -55,7 +55,7 @@ Options object > **contrast**: `number` -Defined in: [src/filters/Contrast.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Contrast.ts#L29) +Defined in: [src/filters/Contrast.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Contrast.ts#L29) contrast value, range from -1 to 1. @@ -73,7 +73,7 @@ contrast value, range from -1 to 1. > `static` **defaults**: `ContrastOwnProps` = `contrastDefaultValues` -Defined in: [src/filters/Contrast.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Contrast.ts#L33) +Defined in: [src/filters/Contrast.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Contrast.ts#L33) #### Overrides @@ -85,7 +85,7 @@ Defined in: [src/filters/Contrast.ts:33](https://github.com/fabricjs/fabric.js/b > `static` **type**: `string` = `'Contrast'` -Defined in: [src/filters/Contrast.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Contrast.ts#L31) +Defined in: [src/filters/Contrast.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Contrast.ts#L31) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -103,7 +103,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Contrast.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Contrast.ts#L35) +Defined in: [src/filters/Contrast.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Contrast.ts#L35) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -121,7 +121,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -139,7 +139,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -161,7 +161,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -183,7 +183,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -209,7 +209,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Contrast.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Contrast.ts#L51) +Defined in: [src/filters/Contrast.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Contrast.ts#L51) Apply the Contrast operation to a Uint8Array representing the pixels of an image. @@ -233,7 +233,7 @@ Apply the Contrast operation to a Uint8Array representing the pixels of an image > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -257,7 +257,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -287,7 +287,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -312,7 +312,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -362,7 +362,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -396,7 +396,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -415,7 +415,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/Contrast.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Contrast.ts#L37) +Defined in: [src/filters/Contrast.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Contrast.ts#L37) #### Returns @@ -431,7 +431,7 @@ Defined in: [src/filters/Contrast.ts:37](https://github.com/fabricjs/fabric.js/b > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -465,7 +465,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -481,7 +481,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Contrast.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Contrast.ts#L41) +Defined in: [src/filters/Contrast.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Contrast.ts#L41) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -502,7 +502,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -528,7 +528,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -564,7 +564,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Contrast.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Contrast.ts#L68) +Defined in: [src/filters/Contrast.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Contrast.ts#L68) Send data from this filter to its shader program's uniforms. @@ -596,7 +596,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `ContrastOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -616,7 +616,7 @@ JSON > **toObject**(): `object` & `ContrastOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -638,7 +638,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -664,7 +664,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Convolute.md b/src/content/docs/api/fabric/namespaces/filters/classes/Convolute.md index 528f10df..78fd02d8 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Convolute.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Convolute.md @@ -5,7 +5,7 @@ prev: false title: "Convolute" --- -Defined in: [src/filters/Convolute.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L56) +Defined in: [src/filters/Convolute.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L56) Adapted from html5rocks article @@ -66,7 +66,7 @@ canvas.renderAll(); > **new Convolute**(`options?`): `Convolute` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -92,7 +92,7 @@ Options object > **matrix**: `number`[] -Defined in: [src/filters/Convolute.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L65) +Defined in: [src/filters/Convolute.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L65) *** @@ -100,7 +100,7 @@ Defined in: [src/filters/Convolute.ts:65](https://github.com/fabricjs/fabric.js/ > **opaque**: `boolean` -Defined in: [src/filters/Convolute.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L60) +Defined in: [src/filters/Convolute.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L60) *** @@ -108,7 +108,7 @@ Defined in: [src/filters/Convolute.ts:60](https://github.com/fabricjs/fabric.js/ > `static` **defaults**: `ConvoluteOwnProps` = `convoluteDefaultValues` -Defined in: [src/filters/Convolute.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L69) +Defined in: [src/filters/Convolute.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L69) #### Overrides @@ -120,7 +120,7 @@ Defined in: [src/filters/Convolute.ts:69](https://github.com/fabricjs/fabric.js/ > `static` **type**: `string` = `'Convolute'` -Defined in: [src/filters/Convolute.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L67) +Defined in: [src/filters/Convolute.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L67) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -138,7 +138,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Convolute.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L71) +Defined in: [src/filters/Convolute.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L71) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -156,7 +156,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -174,7 +174,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -196,7 +196,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -218,7 +218,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -244,7 +244,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Convolute.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L89) +Defined in: [src/filters/Convolute.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L89) Apply the Brightness operation to a Uint8ClampedArray representing the pixels of an image. @@ -268,7 +268,7 @@ Apply the Brightness operation to a Uint8ClampedArray representing the pixels of > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -292,7 +292,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -322,7 +322,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -347,7 +347,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -397,7 +397,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -431,7 +431,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `"Convolute_3_1"` \| `"Convolute_3_0"` \| `"Convolute_5_1"` \| `"Convolute_5_0"` \| `"Convolute_7_1"` \| `"Convolute_7_0"` \| `"Convolute_9_1"` \| `"Convolute_9_0"` -Defined in: [src/filters/Convolute.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L73) +Defined in: [src/filters/Convolute.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L73) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -450,7 +450,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/Convolute.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L79) +Defined in: [src/filters/Convolute.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L79) #### Returns @@ -466,7 +466,7 @@ Defined in: [src/filters/Convolute.ts:79](https://github.com/fabricjs/fabric.js/ > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -500,7 +500,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -516,7 +516,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(`options?`): `boolean` -Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L246) +Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L246) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -543,7 +543,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -569,7 +569,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -605,7 +605,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Convolute.ts:154](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L154) +Defined in: [src/filters/Convolute.ts:153](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L153) Send data from this filter to its shader program's uniforms. @@ -637,7 +637,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `ConvoluteOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -657,7 +657,7 @@ JSON > **toObject**(): `object` -Defined in: [src/filters/Convolute.ts:165](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Convolute.ts#L165) +Defined in: [src/filters/Convolute.ts:164](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Convolute.ts#L164) Returns object representation of an instance @@ -689,7 +689,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -715,7 +715,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Gamma.md b/src/content/docs/api/fabric/namespaces/filters/classes/Gamma.md index d2e7a01a..d9c5b1f4 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Gamma.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Gamma.md @@ -5,7 +5,7 @@ prev: false title: "Gamma" --- -Defined in: [src/filters/Gamma.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L27) +Defined in: [src/filters/Gamma.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L27) Gamma filter class @@ -29,7 +29,7 @@ object.applyFilters(); > **new Gamma**(`options`): `Gamma` -Defined in: [src/filters/Gamma.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L49) +Defined in: [src/filters/Gamma.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L49) #### Parameters @@ -53,7 +53,7 @@ Defined in: [src/filters/Gamma.ts:49](https://github.com/fabricjs/fabric.js/blob > **gamma**: `GammaInput` -Defined in: [src/filters/Gamma.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L32) +Defined in: [src/filters/Gamma.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L32) Gamma array value, from 0.01 to 2.2. @@ -65,7 +65,7 @@ Gamma array value, from 0.01 to 2.2. > `optional` **rgbValues**: `object` -Defined in: [src/filters/Gamma.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L33) +Defined in: [src/filters/Gamma.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L33) #### b @@ -85,7 +85,7 @@ Defined in: [src/filters/Gamma.ts:33](https://github.com/fabricjs/fabric.js/blob > `static` **defaults**: `GammaOwnProps` = `gammaDefaultValues` -Defined in: [src/filters/Gamma.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L41) +Defined in: [src/filters/Gamma.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L41) #### Overrides @@ -97,7 +97,7 @@ Defined in: [src/filters/Gamma.ts:41](https://github.com/fabricjs/fabric.js/blob > `static` **type**: `"Gamma"` = `GAMMA` -Defined in: [src/filters/Gamma.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L39) +Defined in: [src/filters/Gamma.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L39) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -115,7 +115,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Gamma.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L43) +Defined in: [src/filters/Gamma.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L43) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -133,7 +133,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -151,7 +151,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -173,7 +173,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -195,7 +195,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -221,7 +221,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Gamma.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L64) +Defined in: [src/filters/Gamma.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L64) Apply the Gamma operation to a Uint8Array representing the pixels of an image. @@ -245,7 +245,7 @@ Apply the Gamma operation to a Uint8Array representing the pixels of an image. > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -269,7 +269,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -299,7 +299,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -324,7 +324,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -374,7 +374,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -408,7 +408,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -427,7 +427,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/Gamma.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L45) +Defined in: [src/filters/Gamma.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L45) #### Returns @@ -443,7 +443,7 @@ Defined in: [src/filters/Gamma.ts:45](https://github.com/fabricjs/fabric.js/blob > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -477,7 +477,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -493,7 +493,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Gamma.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L106) +Defined in: [src/filters/Gamma.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L106) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -514,7 +514,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -540,7 +540,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -576,7 +576,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Gamma.ts:99](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L99) +Defined in: [src/filters/Gamma.ts:99](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L99) Send data from this filter to its shader program's uniforms. @@ -608,7 +608,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `GammaOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -628,7 +628,7 @@ JSON > **toObject**(): `object` -Defined in: [src/filters/Gamma.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Gamma.ts#L111) +Defined in: [src/filters/Gamma.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Gamma.ts#L111) Returns object representation of an instance It will automatically export the default values of a filter, @@ -658,7 +658,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -684,7 +684,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Grayscale.md b/src/content/docs/api/fabric/namespaces/filters/classes/Grayscale.md index 75b0a874..a3388890 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Grayscale.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Grayscale.md @@ -5,7 +5,7 @@ prev: false title: "Grayscale" --- -Defined in: [src/filters/Grayscale.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L23) +Defined in: [src/filters/Grayscale.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L23) Grayscale image filter class @@ -27,7 +27,7 @@ object.applyFilters(); > **new Grayscale**(`options?`): `Grayscale` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -53,7 +53,7 @@ Options object > **mode**: `TGrayscaleMode` -Defined in: [src/filters/Grayscale.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L24) +Defined in: [src/filters/Grayscale.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L24) *** @@ -61,7 +61,7 @@ Defined in: [src/filters/Grayscale.ts:24](https://github.com/fabricjs/fabric.js/ > `static` **defaults**: `GrayscaleOwnProps` = `grayscaleDefaultValues` -Defined in: [src/filters/Grayscale.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L28) +Defined in: [src/filters/Grayscale.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L28) #### Overrides @@ -73,7 +73,7 @@ Defined in: [src/filters/Grayscale.ts:28](https://github.com/fabricjs/fabric.js/ > `static` **type**: `string` = `'Grayscale'` -Defined in: [src/filters/Grayscale.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L26) +Defined in: [src/filters/Grayscale.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L26) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -91,7 +91,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Grayscale.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L30) +Defined in: [src/filters/Grayscale.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L30) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -109,7 +109,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -127,7 +127,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -149,7 +149,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -171,7 +171,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -197,7 +197,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Grayscale.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L38) +Defined in: [src/filters/Grayscale.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L38) Apply the Grayscale operation to a Uint8Array representing the pixels of an image. @@ -221,7 +221,7 @@ Apply the Grayscale operation to a Uint8Array representing the pixels of an imag > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -245,7 +245,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -275,7 +275,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -300,7 +300,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -350,7 +350,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -384,7 +384,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/Grayscale.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L59) +Defined in: [src/filters/Grayscale.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L59) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -403,7 +403,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/Grayscale.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L63) +Defined in: [src/filters/Grayscale.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L63) #### Returns @@ -419,7 +419,7 @@ Defined in: [src/filters/Grayscale.ts:63](https://github.com/fabricjs/fabric.js/ > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -453,7 +453,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -469,7 +469,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Grayscale.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L86) +Defined in: [src/filters/Grayscale.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L86) Grayscale filter isNeutralState implementation The filter is never neutral @@ -489,7 +489,7 @@ on the image > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -515,7 +515,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -551,7 +551,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Grayscale.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Grayscale.ts#L73) +Defined in: [src/filters/Grayscale.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Grayscale.ts#L73) Send data from this filter to its shader program's uniforms. @@ -583,7 +583,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `GrayscaleOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -603,7 +603,7 @@ JSON > **toObject**(): `object` & `GrayscaleOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -625,7 +625,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -651,7 +651,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/HueRotation.md b/src/content/docs/api/fabric/namespaces/filters/classes/HueRotation.md index 55f673e2..4bf33193 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/HueRotation.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/HueRotation.md @@ -5,7 +5,7 @@ prev: false title: "HueRotation" --- -Defined in: [src/filters/HueRotation.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/HueRotation.ts#L33) +Defined in: [src/filters/HueRotation.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/HueRotation.ts#L33) HueRotation filter class @@ -29,7 +29,7 @@ object.applyFilters(); > **new HueRotation**(`options?`): `HueRotation` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -55,7 +55,7 @@ Options object > **colorsOnly**: `boolean` -Defined in: [src/filters/ColorMatrix.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L56) +Defined in: [src/filters/ColorMatrix.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L56) Lock the colormatrix on the color part, skipping alpha, mainly for non webgl scenario to save some calculation @@ -76,7 +76,7 @@ true > **matrix**: [`TMatColorMatrix`](/api/type-aliases/tmatcolormatrix/) -Defined in: [src/filters/ColorMatrix.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L48) +Defined in: [src/filters/ColorMatrix.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L48) Colormatrix for pixels. array of 20 floats. Numbers in positions 4, 9, 14, 19 loose meaning @@ -97,7 +97,7 @@ array of 20 numbers. > **rotation**: `number` -Defined in: [src/filters/HueRotation.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/HueRotation.ts#L41) +Defined in: [src/filters/HueRotation.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/HueRotation.ts#L41) HueRotation value, from -1 to 1. @@ -107,7 +107,7 @@ HueRotation value, from -1 to 1. > `static` **defaults**: `HueRotationOwnProps` = `hueRotationDefaultValues` -Defined in: [src/filters/HueRotation.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/HueRotation.ts#L45) +Defined in: [src/filters/HueRotation.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/HueRotation.ts#L45) #### Overrides @@ -119,7 +119,7 @@ Defined in: [src/filters/HueRotation.ts:45](https://github.com/fabricjs/fabric.j > `static` **type**: `string` = `'HueRotation'` -Defined in: [src/filters/HueRotation.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/HueRotation.ts#L43) +Defined in: [src/filters/HueRotation.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/HueRotation.ts#L43) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -137,7 +137,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/ColorMatrix.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L62) +Defined in: [src/filters/ColorMatrix.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L62) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -155,7 +155,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -173,7 +173,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -195,7 +195,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -217,7 +217,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/HueRotation.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/HueRotation.ts#L82) +Defined in: [src/filters/HueRotation.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/HueRotation.ts#L82) Apply this filter to the input image data provided. @@ -243,7 +243,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/ColorMatrix.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L74) +Defined in: [src/filters/ColorMatrix.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L74) Apply the ColorMatrix operation to a Uint8Array representing the pixels of an image. @@ -267,7 +267,7 @@ Apply the ColorMatrix operation to a Uint8Array representing the pixels of an im > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -291,7 +291,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -321,7 +321,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **calculateMatrix**(): `void` -Defined in: [src/filters/HueRotation.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/HueRotation.ts#L47) +Defined in: [src/filters/HueRotation.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/HueRotation.ts#L47) #### Returns @@ -333,7 +333,7 @@ Defined in: [src/filters/HueRotation.ts:47](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -358,7 +358,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -408,7 +408,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -442,7 +442,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -461,7 +461,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/ColorMatrix.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L64) +Defined in: [src/filters/ColorMatrix.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L64) #### Returns @@ -477,7 +477,7 @@ Defined in: [src/filters/ColorMatrix.ts:64](https://github.com/fabricjs/fabric.j > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -511,7 +511,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -527,7 +527,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/HueRotation.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/HueRotation.ts#L78) +Defined in: [src/filters/HueRotation.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/HueRotation.ts#L78) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -548,7 +548,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -574,7 +574,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -610,7 +610,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/ColorMatrix.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrix.ts#L105) +Defined in: [src/filters/ColorMatrix.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrix.ts#L105) Send data from this filter to its shader program's uniforms. @@ -642,7 +642,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `HueRotationSerializedProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -662,7 +662,7 @@ JSON > **toObject**(): `object` -Defined in: [src/filters/HueRotation.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/HueRotation.ts#L87) +Defined in: [src/filters/HueRotation.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/HueRotation.ts#L87) Returns object representation of an instance It will automatically export the default values of a filter, @@ -692,7 +692,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -718,7 +718,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Invert.md b/src/content/docs/api/fabric/namespaces/filters/classes/Invert.md index d0c8ab01..14cafff6 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Invert.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Invert.md @@ -5,7 +5,7 @@ prev: false title: "Invert" --- -Defined in: [src/filters/Invert.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Invert.ts#L22) +Defined in: [src/filters/Invert.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Invert.ts#L22) ## Example @@ -25,7 +25,7 @@ object.applyFilters(canvas.renderAll.bind(canvas)); > **new Invert**(`options?`): `Invert` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -51,7 +51,7 @@ Options object > **alpha**: `boolean` -Defined in: [src/filters/Invert.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Invert.ts#L27) +Defined in: [src/filters/Invert.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Invert.ts#L27) Invert also alpha. @@ -63,7 +63,7 @@ Invert also alpha. > **invert**: `boolean` -Defined in: [src/filters/Invert.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Invert.ts#L33) +Defined in: [src/filters/Invert.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Invert.ts#L33) Filter invert. if false, does nothing @@ -75,7 +75,7 @@ Filter invert. if false, does nothing > `static` **defaults**: `InvertOwnProps` = `invertDefaultValues` -Defined in: [src/filters/Invert.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Invert.ts#L37) +Defined in: [src/filters/Invert.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Invert.ts#L37) #### Overrides @@ -87,7 +87,7 @@ Defined in: [src/filters/Invert.ts:37](https://github.com/fabricjs/fabric.js/blo > `static` **type**: `string` = `'Invert'` -Defined in: [src/filters/Invert.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Invert.ts#L35) +Defined in: [src/filters/Invert.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Invert.ts#L35) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -105,7 +105,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Invert.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Invert.ts#L39) +Defined in: [src/filters/Invert.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Invert.ts#L39) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -123,7 +123,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -141,7 +141,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -163,7 +163,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -185,7 +185,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -211,7 +211,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Invert.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Invert.ts#L47) +Defined in: [src/filters/Invert.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Invert.ts#L47) Apply the Invert operation to a Uint8Array representing the pixels of an image. @@ -235,7 +235,7 @@ Apply the Invert operation to a Uint8Array representing the pixels of an image. > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -259,7 +259,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -289,7 +289,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -314,7 +314,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -364,7 +364,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -398,7 +398,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -417,7 +417,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -451,7 +451,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -467,7 +467,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Invert.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Invert.ts#L69) +Defined in: [src/filters/Invert.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Invert.ts#L69) Invert filter isNeutralState implementation Used only in image applyFilters to discard filters that will not have an effect @@ -487,7 +487,7 @@ on the image > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -513,7 +513,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -549,7 +549,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Invert.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Invert.ts#L79) +Defined in: [src/filters/Invert.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Invert.ts#L79) Send data from this filter to its shader program's uniforms. @@ -581,7 +581,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `InvertOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -601,7 +601,7 @@ JSON > **toObject**(): `object` & `InvertOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -623,7 +623,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -649,7 +649,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Noise.md b/src/content/docs/api/fabric/namespaces/filters/classes/Noise.md index 01a4c353..638d9a62 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Noise.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Noise.md @@ -5,7 +5,7 @@ prev: false title: "Noise" --- -Defined in: [src/filters/Noise.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Noise.ts#L24) +Defined in: [src/filters/Noise.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Noise.ts#L24) Noise filter class @@ -30,7 +30,7 @@ canvas.renderAll(); > **new Noise**(`options?`): `Noise` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -56,7 +56,7 @@ Options object > **noise**: `number` -Defined in: [src/filters/Noise.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Noise.ts#L29) +Defined in: [src/filters/Noise.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Noise.ts#L29) Noise value, from @@ -68,7 +68,7 @@ Noise value, from > `static` **defaults**: `NoiseOwnProps` = `noiseDefaultValues` -Defined in: [src/filters/Noise.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Noise.ts#L33) +Defined in: [src/filters/Noise.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Noise.ts#L33) #### Overrides @@ -80,7 +80,7 @@ Defined in: [src/filters/Noise.ts:33](https://github.com/fabricjs/fabric.js/blob > `static` **type**: `string` = `'Noise'` -Defined in: [src/filters/Noise.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Noise.ts#L31) +Defined in: [src/filters/Noise.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Noise.ts#L31) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -98,7 +98,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Noise.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Noise.ts#L35) +Defined in: [src/filters/Noise.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Noise.ts#L35) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -116,7 +116,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -134,7 +134,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -156,7 +156,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -178,7 +178,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -204,7 +204,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Noise.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Noise.ts#L47) +Defined in: [src/filters/Noise.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Noise.ts#L47) Apply the Brightness operation to a Uint8ClampedArray representing the pixels of an image. @@ -228,7 +228,7 @@ Apply the Brightness operation to a Uint8ClampedArray representing the pixels of > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -252,7 +252,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -282,7 +282,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -307,7 +307,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -357,7 +357,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -391,7 +391,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -410,7 +410,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/Noise.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Noise.ts#L37) +Defined in: [src/filters/Noise.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Noise.ts#L37) #### Returns @@ -426,7 +426,7 @@ Defined in: [src/filters/Noise.ts:37](https://github.com/fabricjs/fabric.js/blob > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -460,7 +460,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -476,7 +476,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Noise.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Noise.ts#L71) +Defined in: [src/filters/Noise.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Noise.ts#L71) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -497,7 +497,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -523,7 +523,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -559,7 +559,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Noise.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Noise.ts#L63) +Defined in: [src/filters/Noise.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Noise.ts#L63) Send data from this filter to its shader program's uniforms. @@ -591,7 +591,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `NoiseOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -611,7 +611,7 @@ JSON > **toObject**(): `object` & `NoiseOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -633,7 +633,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -659,7 +659,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Pixelate.md b/src/content/docs/api/fabric/namespaces/filters/classes/Pixelate.md index 9ec45202..582f8a2d 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Pixelate.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Pixelate.md @@ -5,7 +5,7 @@ prev: false title: "Pixelate" --- -Defined in: [src/filters/Pixelate.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Pixelate.ts#L23) +Defined in: [src/filters/Pixelate.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Pixelate.ts#L23) Pixelate filter class @@ -29,7 +29,7 @@ object.applyFilters(); > **new Pixelate**(`options?`): `Pixelate` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -55,7 +55,7 @@ Options object > **blocksize**: `number` -Defined in: [src/filters/Pixelate.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Pixelate.ts#L24) +Defined in: [src/filters/Pixelate.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Pixelate.ts#L24) *** @@ -63,7 +63,7 @@ Defined in: [src/filters/Pixelate.ts:24](https://github.com/fabricjs/fabric.js/b > `static` **defaults**: `PixelateOwnProps` = `pixelateDefaultValues` -Defined in: [src/filters/Pixelate.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Pixelate.ts#L28) +Defined in: [src/filters/Pixelate.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Pixelate.ts#L28) #### Overrides @@ -75,7 +75,7 @@ Defined in: [src/filters/Pixelate.ts:28](https://github.com/fabricjs/fabric.js/b > `static` **type**: `string` = `'Pixelate'` -Defined in: [src/filters/Pixelate.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Pixelate.ts#L26) +Defined in: [src/filters/Pixelate.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Pixelate.ts#L26) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -93,7 +93,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Pixelate.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Pixelate.ts#L30) +Defined in: [src/filters/Pixelate.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Pixelate.ts#L30) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -111,7 +111,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -129,7 +129,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -151,7 +151,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -173,7 +173,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -199,7 +199,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Pixelate.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Pixelate.ts#L38) +Defined in: [src/filters/Pixelate.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Pixelate.ts#L38) Apply the Pixelate operation to a Uint8ClampedArray representing the pixels of an image. @@ -223,7 +223,7 @@ Apply the Pixelate operation to a Uint8ClampedArray representing the pixels of a > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -247,7 +247,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -277,7 +277,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -302,7 +302,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -352,7 +352,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -386,7 +386,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -405,7 +405,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -439,7 +439,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -455,7 +455,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Pixelate.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Pixelate.ts#L63) +Defined in: [src/filters/Pixelate.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Pixelate.ts#L63) Indicate when the filter is not gonna apply changes to the image @@ -473,7 +473,7 @@ Indicate when the filter is not gonna apply changes to the image > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -499,7 +499,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -535,7 +535,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Pixelate.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Pixelate.ts#L77) +Defined in: [src/filters/Pixelate.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Pixelate.ts#L77) Send data from this filter to its shader program's uniforms. @@ -567,7 +567,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `PixelateOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -587,7 +587,7 @@ JSON > **toObject**(): `object` & `PixelateOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -609,7 +609,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -635,7 +635,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/RemoveColor.md b/src/content/docs/api/fabric/namespaces/filters/classes/RemoveColor.md index 8030485d..a3688cbf 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/RemoveColor.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/RemoveColor.md @@ -5,7 +5,7 @@ prev: false title: "RemoveColor" --- -Defined in: [src/filters/RemoveColor.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L29) +Defined in: [src/filters/RemoveColor.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L29) Remove white filter class @@ -30,7 +30,7 @@ canvas.renderAll(); > **new RemoveColor**(`options?`): `RemoveColor` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -56,7 +56,7 @@ Options object > **color**: `string` -Defined in: [src/filters/RemoveColor.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L36) +Defined in: [src/filters/RemoveColor.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L36) Color to remove, in any format understood by [Color](/api/classes/color/). @@ -66,7 +66,7 @@ Color to remove, in any format understood by [Color](/api/classes/color/). > **distance**: `number` -Defined in: [src/filters/RemoveColor.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L42) +Defined in: [src/filters/RemoveColor.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L42) distance to actual color, as value up or down from each r,g,b between 0 and 1 @@ -77,7 +77,7 @@ between 0 and 1 > **useAlpha**: `boolean` -Defined in: [src/filters/RemoveColor.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L48) +Defined in: [src/filters/RemoveColor.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L48) For color to remove inside distance, use alpha channel for a smoother deletion NOT IMPLEMENTED YET @@ -88,7 +88,7 @@ NOT IMPLEMENTED YET > `static` **defaults**: `RemoveColorOwnProps` = `removeColorDefaultValues` -Defined in: [src/filters/RemoveColor.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L52) +Defined in: [src/filters/RemoveColor.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L52) #### Overrides @@ -100,7 +100,7 @@ Defined in: [src/filters/RemoveColor.ts:52](https://github.com/fabricjs/fabric.j > `static` **type**: `string` = `'RemoveColor'` -Defined in: [src/filters/RemoveColor.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L50) +Defined in: [src/filters/RemoveColor.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L50) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -118,7 +118,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/RemoveColor.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L54) +Defined in: [src/filters/RemoveColor.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L54) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -136,7 +136,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -154,7 +154,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -176,7 +176,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -198,7 +198,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -224,7 +224,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`canvasEl`): `void` -Defined in: [src/filters/RemoveColor.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L64) +Defined in: [src/filters/RemoveColor.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L64) Applies filter to canvas element @@ -250,7 +250,7 @@ Canvas element to apply filter to > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -274,7 +274,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -304,7 +304,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -329,7 +329,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -379,7 +379,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -413,7 +413,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -432,7 +432,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/RemoveColor.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L56) +Defined in: [src/filters/RemoveColor.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L56) #### Returns @@ -448,7 +448,7 @@ Defined in: [src/filters/RemoveColor.ts:56](https://github.com/fabricjs/fabric.j > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -482,7 +482,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -498,7 +498,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(`options?`): `boolean` -Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L246) +Defined in: [src/filters/BaseFilter.ts:246](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L246) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -525,7 +525,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -551,7 +551,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -587,7 +587,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/RemoveColor.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/RemoveColor.ts#L98) +Defined in: [src/filters/RemoveColor.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/RemoveColor.ts#L98) Send data from this filter to its shader program's uniforms. @@ -619,7 +619,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `RemoveColorOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -639,7 +639,7 @@ JSON > **toObject**(): `object` & `RemoveColorOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -661,7 +661,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -687,7 +687,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Resize.md b/src/content/docs/api/fabric/namespaces/filters/classes/Resize.md index f582ff1a..9993ae80 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Resize.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Resize.md @@ -5,7 +5,7 @@ prev: false title: "Resize" --- -Defined in: [src/filters/Resize.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L54) +Defined in: [src/filters/Resize.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L54) Resize image filter class @@ -27,7 +27,7 @@ object.applyFilters(canvas.renderAll.bind(canvas)); > **new Resize**(`options?`): `Resize` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -53,7 +53,7 @@ Options object > **lanczosLobes**: `number` -Defined in: [src/filters/Resize.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L78) +Defined in: [src/filters/Resize.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L78) LanczosLobes parameter for lanczos filter, valid for resizeType lanczos @@ -65,7 +65,7 @@ LanczosLobes parameter for lanczos filter, valid for resizeType lanczos > **resizeType**: [`TResizeType`](/api/fabric/namespaces/filters/type-aliases/tresizetype/) -Defined in: [src/filters/Resize.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L60) +Defined in: [src/filters/Resize.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L60) Resize type for webgl resizeType is just lanczos, for canvas2d can be: @@ -77,7 +77,7 @@ bilinear, hermite, sliceHack, lanczos. > **scaleX**: `number` -Defined in: [src/filters/Resize.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L66) +Defined in: [src/filters/Resize.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L66) Scale factor for resizing, x axis @@ -89,7 +89,7 @@ Scale factor for resizing, x axis > **scaleY**: `number` -Defined in: [src/filters/Resize.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L72) +Defined in: [src/filters/Resize.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L72) Scale factor for resizing, y axis @@ -101,7 +101,7 @@ Scale factor for resizing, y axis > `static` **defaults**: `ResizeOwnProps` = `resizeDefaultValues` -Defined in: [src/filters/Resize.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L82) +Defined in: [src/filters/Resize.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L82) #### Overrides @@ -113,7 +113,7 @@ Defined in: [src/filters/Resize.ts:82](https://github.com/fabricjs/fabric.js/blo > `static` **type**: `string` = `'Resize'` -Defined in: [src/filters/Resize.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L80) +Defined in: [src/filters/Resize.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L80) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -131,7 +131,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Resize.ts:84](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L84) +Defined in: [src/filters/Resize.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L84) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -149,7 +149,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -167,7 +167,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -189,7 +189,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -211,7 +211,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/Resize.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L195) +Defined in: [src/filters/Resize.ts:195](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L195) Apply the resize filter to the image Determines whether to use WebGL or Canvas2D based on the options.webgl flag. @@ -236,7 +236,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`this`, `options`): `void` -Defined in: [src/filters/Resize.ts:221](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L221) +Defined in: [src/filters/Resize.ts:221](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L221) #### Parameters @@ -262,7 +262,7 @@ Defined in: [src/filters/Resize.ts:221](https://github.com/fabricjs/fabric.js/bl > **applyToForWebgl**(`this`, `options`): `void` -Defined in: [src/filters/Resize.ts:161](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L161) +Defined in: [src/filters/Resize.ts:161](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L161) #### Parameters @@ -284,7 +284,7 @@ Defined in: [src/filters/Resize.ts:161](https://github.com/fabricjs/fabric.js/bl > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -308,7 +308,7 @@ Apply this filter using webgl. > **bilinearFiltering**(`this`, `options`, `oW`, `oH`, `dW`, `dH`): `ImageData` -Defined in: [src/filters/Resize.ts:415](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L415) +Defined in: [src/filters/Resize.ts:415](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L415) bilinearFiltering @@ -356,7 +356,7 @@ Destination Height > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -386,7 +386,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -411,7 +411,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -461,7 +461,7 @@ vertexShader source for compilation > **generateShader**(`filterWindow`): `string` -Defined in: [src/filters/Resize.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L134) +Defined in: [src/filters/Resize.ts:134](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L134) Generate vertex and shader sources from the necessary steps numbers @@ -481,7 +481,7 @@ Generate vertex and shader sources from the necessary steps numbers > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -515,7 +515,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(`this`): `string` -Defined in: [src/filters/Resize.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L109) +Defined in: [src/filters/Resize.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L109) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -540,7 +540,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFilterWindow**(`this`): `number` -Defined in: [src/filters/Resize.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L104) +Defined in: [src/filters/Resize.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L104) #### Parameters @@ -558,7 +558,7 @@ Defined in: [src/filters/Resize.ts:104](https://github.com/fabricjs/fabric.js/bl > **getFragmentSource**(`this`): `string` -Defined in: [src/filters/Resize.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L114) +Defined in: [src/filters/Resize.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L114) #### Parameters @@ -580,7 +580,7 @@ Defined in: [src/filters/Resize.ts:114](https://github.com/fabricjs/fabric.js/bl > **getTaps**(`this`): `any`[] -Defined in: [src/filters/Resize.ts:119](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L119) +Defined in: [src/filters/Resize.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L119) #### Parameters @@ -598,7 +598,7 @@ Defined in: [src/filters/Resize.ts:119](https://github.com/fabricjs/fabric.js/bl > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -632,7 +632,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -648,7 +648,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **hermiteFastResize**(`this`, `options`, `oW`, `oH`, `dW`, `dH`): `ImageData` -Defined in: [src/filters/Resize.ts:478](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L478) +Defined in: [src/filters/Resize.ts:478](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L478) hermiteFastResize @@ -696,7 +696,7 @@ Destination Height > **isNeutralState**(): `boolean` -Defined in: [src/filters/Resize.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L203) +Defined in: [src/filters/Resize.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L203) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -717,7 +717,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **lanczosCreate**(`lobes`): (`x`) => `number` -Defined in: [src/filters/Resize.ts:207](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L207) +Defined in: [src/filters/Resize.ts:207](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L207) #### Parameters @@ -745,7 +745,7 @@ Defined in: [src/filters/Resize.ts:207](https://github.com/fabricjs/fabric.js/bl > **lanczosResize**(`this`, `options`, `oW`, `oH`, `dW`, `dH`): `ImageData` -Defined in: [src/filters/Resize.ts:324](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L324) +Defined in: [src/filters/Resize.ts:324](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L324) Filter lanczosResize @@ -793,7 +793,7 @@ Destination Height > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -819,7 +819,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -855,7 +855,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`this`, `gl`, `uniformLocations`): `void` -Defined in: [src/filters/Resize.ts:92](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L92) +Defined in: [src/filters/Resize.ts:92](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L92) Send data from this filter to its shader program's uniforms. @@ -891,7 +891,7 @@ A map of string uniform names to WebGLUniformLocation objects > **sliceByTwo**(`options`, `oW`, `oH`, `dW`, `dH`): `ImageData` -Defined in: [src/filters/Resize.ts:259](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L259) +Defined in: [src/filters/Resize.ts:259](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L259) Filter sliceByTwo @@ -935,7 +935,7 @@ Destination Height > **toJSON**(): `object` & `ResizeOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -955,7 +955,7 @@ JSON > **toObject**(): `object` & `ResizeOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -977,7 +977,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -1003,7 +1003,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Saturation.md b/src/content/docs/api/fabric/namespaces/filters/classes/Saturation.md index f413f283..107075e9 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Saturation.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Saturation.md @@ -5,7 +5,7 @@ prev: false title: "Saturation" --- -Defined in: [src/filters/Saturation.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Saturation.ts#L23) +Defined in: [src/filters/Saturation.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Saturation.ts#L23) Saturate filter class @@ -29,7 +29,7 @@ object.applyFilters(); > **new Saturation**(`options?`): `Saturation` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -55,7 +55,7 @@ Options object > **saturation**: `number` -Defined in: [src/filters/Saturation.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Saturation.ts#L31) +Defined in: [src/filters/Saturation.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Saturation.ts#L31) Saturation value, from -1 to 1. Increases/decreases the color saturation. @@ -69,7 +69,7 @@ A value of 0 has no effect. > `static` **defaults**: `SaturationOwnProps` = `saturationDefaultValues` -Defined in: [src/filters/Saturation.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Saturation.ts#L35) +Defined in: [src/filters/Saturation.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Saturation.ts#L35) #### Overrides @@ -81,7 +81,7 @@ Defined in: [src/filters/Saturation.ts:35](https://github.com/fabricjs/fabric.js > `static` **type**: `string` = `'Saturation'` -Defined in: [src/filters/Saturation.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Saturation.ts#L33) +Defined in: [src/filters/Saturation.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Saturation.ts#L33) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -99,7 +99,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Saturation.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Saturation.ts#L37) +Defined in: [src/filters/Saturation.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Saturation.ts#L37) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -117,7 +117,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -135,7 +135,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -157,7 +157,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -179,7 +179,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -205,7 +205,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Saturation.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Saturation.ts#L49) +Defined in: [src/filters/Saturation.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Saturation.ts#L49) Apply the Saturation operation to a Uint8ClampedArray representing the pixels of an image. @@ -229,7 +229,7 @@ Apply the Saturation operation to a Uint8ClampedArray representing the pixels of > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -253,7 +253,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -283,7 +283,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -308,7 +308,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -358,7 +358,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -392,7 +392,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -411,7 +411,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/Saturation.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Saturation.ts#L39) +Defined in: [src/filters/Saturation.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Saturation.ts#L39) #### Returns @@ -427,7 +427,7 @@ Defined in: [src/filters/Saturation.ts:39](https://github.com/fabricjs/fabric.js > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -461,7 +461,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -477,7 +477,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Saturation.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Saturation.ts#L75) +Defined in: [src/filters/Saturation.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Saturation.ts#L75) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -498,7 +498,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -524,7 +524,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -560,7 +560,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Saturation.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Saturation.ts#L68) +Defined in: [src/filters/Saturation.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Saturation.ts#L68) Send data from this filter to its shader program's uniforms. @@ -592,7 +592,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `SaturationOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -612,7 +612,7 @@ JSON > **toObject**(): `object` & `SaturationOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -634,7 +634,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -660,7 +660,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/classes/Vibrance.md b/src/content/docs/api/fabric/namespaces/filters/classes/Vibrance.md index 0ccdff15..99b547d0 100644 --- a/src/content/docs/api/fabric/namespaces/filters/classes/Vibrance.md +++ b/src/content/docs/api/fabric/namespaces/filters/classes/Vibrance.md @@ -5,7 +5,7 @@ prev: false title: "Vibrance" --- -Defined in: [src/filters/Vibrance.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Vibrance.ts#L23) +Defined in: [src/filters/Vibrance.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Vibrance.ts#L23) Vibrance filter class @@ -29,7 +29,7 @@ object.applyFilters(); > **new Vibrance**(`options?`): `Vibrance` -Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L55) +Defined in: [src/filters/BaseFilter.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L55) Constructor @@ -55,7 +55,7 @@ Options object > **vibrance**: `number` -Defined in: [src/filters/Vibrance.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Vibrance.ts#L31) +Defined in: [src/filters/Vibrance.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Vibrance.ts#L31) Vibrance value, from -1 to 1. Increases/decreases the saturation of more muted colors with less effect on saturated colors. @@ -69,7 +69,7 @@ A value of 0 has no effect. > `static` **defaults**: `VibranceOwnProps` = `vibranceDefaultValues` -Defined in: [src/filters/Vibrance.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Vibrance.ts#L35) +Defined in: [src/filters/Vibrance.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Vibrance.ts#L35) #### Overrides @@ -81,7 +81,7 @@ Defined in: [src/filters/Vibrance.ts:35](https://github.com/fabricjs/fabric.js/b > `static` **type**: `string` = `'Vibrance'` -Defined in: [src/filters/Vibrance.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Vibrance.ts#L33) +Defined in: [src/filters/Vibrance.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Vibrance.ts#L33) The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used @@ -99,7 +99,7 @@ to avoid doing that. > `static` **uniformLocations**: `string`[] -Defined in: [src/filters/Vibrance.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Vibrance.ts#L37) +Defined in: [src/filters/Vibrance.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Vibrance.ts#L37) Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class @@ -117,7 +117,7 @@ needs to specify all the one that are needed > **get** **type**(): `Name` -Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L29) +Defined in: [src/filters/BaseFilter.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L29) Filter type @@ -135,7 +135,7 @@ Filter type > **\_setupFrameBuffer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L203) +Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L203) #### Parameters @@ -157,7 +157,7 @@ Defined in: [src/filters/BaseFilter.ts:203](https://github.com/fabricjs/fabric.j > **\_swapTextures**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L230) +Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L230) #### Parameters @@ -179,7 +179,7 @@ Defined in: [src/filters/BaseFilter.ts:230](https://github.com/fabricjs/fabric.j > **applyTo**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L263) +Defined in: [src/filters/BaseFilter.ts:263](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L263) Apply this filter to the input image data provided. @@ -205,7 +205,7 @@ Determines whether to use WebGL or Canvas2D based on the options.webgl flag. > **applyTo2d**(`options`): `void` -Defined in: [src/filters/Vibrance.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Vibrance.ts#L49) +Defined in: [src/filters/Vibrance.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Vibrance.ts#L49) Apply the Vibrance operation to a Uint8ClampedArray representing the pixels of an image. @@ -229,7 +229,7 @@ Apply the Vibrance operation to a Uint8ClampedArray representing the pixels of a > **applyToWebGL**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L313) +Defined in: [src/filters/BaseFilter.ts:313](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L313) Apply this filter using webgl. @@ -253,7 +253,7 @@ Apply this filter using webgl. > **bindAdditionalTexture**(`gl`, `texture`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L332) +Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L332) #### Parameters @@ -283,7 +283,7 @@ Defined in: [src/filters/BaseFilter.ts:332](https://github.com/fabricjs/fabric.j > **createHelpLayer**(`options`): `void` -Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L368) +Defined in: [src/filters/BaseFilter.ts:368](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L368) If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain. @@ -308,7 +308,7 @@ remember that options.targetCanvas is available for use till end of chain. > **createProgram**(`gl`, `fragmentSource`, `vertexSource`): `object` -Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L81) +Defined in: [src/filters/BaseFilter.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L81) Compile this filter's shader program. @@ -358,7 +358,7 @@ vertexShader source for compilation > **getAttributeLocations**(`gl`, `program`): [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L151) +Defined in: [src/filters/BaseFilter.ts:151](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L151) Return a map of attribute names to WebGLAttributeLocation objects. @@ -392,7 +392,7 @@ A map of attribute names to attribute locations. > **getCacheKey**(): `string` -Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L282) +Defined in: [src/filters/BaseFilter.ts:282](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L282) Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache @@ -411,7 +411,7 @@ Used to force recompilation when parameters change or to retrieve the shader fro > **getFragmentSource**(): `string` -Defined in: [src/filters/Vibrance.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Vibrance.ts#L39) +Defined in: [src/filters/Vibrance.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Vibrance.ts#L39) #### Returns @@ -427,7 +427,7 @@ Defined in: [src/filters/Vibrance.ts:39](https://github.com/fabricjs/fabric.js/b > **getUniformLocations**(`gl`, `program`): [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L167) +Defined in: [src/filters/BaseFilter.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L167) Return a map of uniform names to WebGLUniformLocation objects. @@ -461,7 +461,7 @@ A map of uniform names to uniform locations. > **getVertexSource**(): `string` -Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L70) +Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L70) #### Returns @@ -477,7 +477,7 @@ Defined in: [src/filters/BaseFilter.ts:70](https://github.com/fabricjs/fabric.js > **isNeutralState**(): `boolean` -Defined in: [src/filters/Vibrance.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Vibrance.ts#L77) +Defined in: [src/filters/Vibrance.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Vibrance.ts#L77) Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect @@ -498,7 +498,7 @@ Other filters may need their own version ( ColorMatrix, HueRotation, gamma, Comp > **retrieveShader**(`options`): [`TWebGLProgramCacheItem`](/api/type-aliases/twebglprogramcacheitem/) -Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L293) +Defined in: [src/filters/BaseFilter.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L293) Retrieves the cached shader. @@ -524,7 +524,7 @@ the compiled program shader > **sendAttributeData**(`gl`, `attributeLocations`, `aPositionData`): `void` -Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L190) +Defined in: [src/filters/BaseFilter.ts:190](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L190) Send attribute data from this filter to its shader program on the GPU. @@ -560,7 +560,7 @@ A map of shader attribute names to their locations. > **sendUniformData**(`gl`, `uniformLocations`): `void` -Defined in: [src/filters/Vibrance.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Vibrance.ts#L70) +Defined in: [src/filters/Vibrance.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Vibrance.ts#L70) Send data from this filter to its shader program's uniforms. @@ -592,7 +592,7 @@ A map of string uniform names to WebGLUniformLocation objects > **toJSON**(): `object` & `VibranceOwnProps` -Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L405) +Defined in: [src/filters/BaseFilter.ts:405](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L405) Returns a JSON representation of an instance @@ -612,7 +612,7 @@ JSON > **toObject**(): `object` & `VibranceOwnProps` -Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L385) +Defined in: [src/filters/BaseFilter.ts:385](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L385) Returns object representation of an instance It will automatically export the default values of a filter, @@ -634,7 +634,7 @@ Object representation of an instance > **unbindAdditionalTexture**(`gl`, `textureUnit`): `void` -Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L343) +Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L343) #### Parameters @@ -660,7 +660,7 @@ Defined in: [src/filters/BaseFilter.ts:343](https://github.com/fabricjs/fabric.j > `static` **fromObject**(`__namedParameters`, `_options?`): `Promise`\<[`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>\> -Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BaseFilter.ts#L410) +Defined in: [src/filters/BaseFilter.ts:410](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BaseFilter.ts#L410) #### Parameters diff --git a/src/content/docs/api/fabric/namespaces/filters/type-aliases/TBlendMode.md b/src/content/docs/api/fabric/namespaces/filters/type-aliases/TBlendMode.md index 0ce9e3b9..10de9900 100644 --- a/src/content/docs/api/fabric/namespaces/filters/type-aliases/TBlendMode.md +++ b/src/content/docs/api/fabric/namespaces/filters/type-aliases/TBlendMode.md @@ -7,4 +7,4 @@ title: "TBlendMode" > **TBlendMode** = `"multiply"` \| `"add"` \| `"difference"` \| `"screen"` \| `"subtract"` \| `"darken"` \| `"lighten"` \| `"overlay"` \| `"exclusion"` \| `"tint"` -Defined in: [src/filters/BlendColor.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/BlendColor.ts#L7) +Defined in: [src/filters/BlendColor.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/BlendColor.ts#L7) diff --git a/src/content/docs/api/fabric/namespaces/filters/type-aliases/TResizeType.md b/src/content/docs/api/fabric/namespaces/filters/type-aliases/TResizeType.md index 2f564709..cd7da890 100644 --- a/src/content/docs/api/fabric/namespaces/filters/type-aliases/TResizeType.md +++ b/src/content/docs/api/fabric/namespaces/filters/type-aliases/TResizeType.md @@ -7,4 +7,4 @@ title: "TResizeType" > **TResizeType** = `"bilinear"` \| `"hermite"` \| `"sliceHack"` \| `"lanczos"` -Defined in: [src/filters/Resize.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/Resize.ts#L12) +Defined in: [src/filters/Resize.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/Resize.ts#L12) diff --git a/src/content/docs/api/fabric/namespaces/filters/variables/BlackWhite.md b/src/content/docs/api/fabric/namespaces/filters/variables/BlackWhite.md index d5cc47ad..cd011296 100644 --- a/src/content/docs/api/fabric/namespaces/filters/variables/BlackWhite.md +++ b/src/content/docs/api/fabric/namespaces/filters/variables/BlackWhite.md @@ -7,4 +7,4 @@ title: "BlackWhite" > `const` **BlackWhite**: *typeof* [`ColorMatrix`](/api/fabric/namespaces/filters/classes/colormatrix/) -Defined in: [src/filters/ColorMatrixFilters.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrixFilters.ts#L78) +Defined in: [src/filters/ColorMatrixFilters.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrixFilters.ts#L78) diff --git a/src/content/docs/api/fabric/namespaces/filters/variables/Brownie.md b/src/content/docs/api/fabric/namespaces/filters/variables/Brownie.md index a45c90d6..2d7d57c4 100644 --- a/src/content/docs/api/fabric/namespaces/filters/variables/Brownie.md +++ b/src/content/docs/api/fabric/namespaces/filters/variables/Brownie.md @@ -7,4 +7,4 @@ title: "Brownie" > `const` **Brownie**: *typeof* [`ColorMatrix`](/api/fabric/namespaces/filters/classes/colormatrix/) -Defined in: [src/filters/ColorMatrixFilters.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrixFilters.ts#L30) +Defined in: [src/filters/ColorMatrixFilters.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrixFilters.ts#L30) diff --git a/src/content/docs/api/fabric/namespaces/filters/variables/Kodachrome.md b/src/content/docs/api/fabric/namespaces/filters/variables/Kodachrome.md index 770d9227..0e6b5634 100644 --- a/src/content/docs/api/fabric/namespaces/filters/variables/Kodachrome.md +++ b/src/content/docs/api/fabric/namespaces/filters/variables/Kodachrome.md @@ -7,4 +7,4 @@ title: "Kodachrome" > `const` **Kodachrome**: *typeof* [`ColorMatrix`](/api/fabric/namespaces/filters/classes/colormatrix/) -Defined in: [src/filters/ColorMatrixFilters.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrixFilters.ts#L46) +Defined in: [src/filters/ColorMatrixFilters.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrixFilters.ts#L46) diff --git a/src/content/docs/api/fabric/namespaces/filters/variables/Polaroid.md b/src/content/docs/api/fabric/namespaces/filters/variables/Polaroid.md index d5660b4f..7c98a3bf 100644 --- a/src/content/docs/api/fabric/namespaces/filters/variables/Polaroid.md +++ b/src/content/docs/api/fabric/namespaces/filters/variables/Polaroid.md @@ -7,4 +7,4 @@ title: "Polaroid" > `const` **Polaroid**: *typeof* [`ColorMatrix`](/api/fabric/namespaces/filters/classes/colormatrix/) -Defined in: [src/filters/ColorMatrixFilters.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrixFilters.ts#L62) +Defined in: [src/filters/ColorMatrixFilters.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrixFilters.ts#L62) diff --git a/src/content/docs/api/fabric/namespaces/filters/variables/Sepia.md b/src/content/docs/api/fabric/namespaces/filters/variables/Sepia.md index 117f2475..b4868f24 100644 --- a/src/content/docs/api/fabric/namespaces/filters/variables/Sepia.md +++ b/src/content/docs/api/fabric/namespaces/filters/variables/Sepia.md @@ -7,4 +7,4 @@ title: "Sepia" > `const` **Sepia**: *typeof* [`ColorMatrix`](/api/fabric/namespaces/filters/classes/colormatrix/) -Defined in: [src/filters/ColorMatrixFilters.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrixFilters.ts#L70) +Defined in: [src/filters/ColorMatrixFilters.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrixFilters.ts#L70) diff --git a/src/content/docs/api/fabric/namespaces/filters/variables/Technicolor.md b/src/content/docs/api/fabric/namespaces/filters/variables/Technicolor.md index d608b283..205427b2 100644 --- a/src/content/docs/api/fabric/namespaces/filters/variables/Technicolor.md +++ b/src/content/docs/api/fabric/namespaces/filters/variables/Technicolor.md @@ -7,4 +7,4 @@ title: "Technicolor" > `const` **Technicolor**: *typeof* [`ColorMatrix`](/api/fabric/namespaces/filters/classes/colormatrix/) -Defined in: [src/filters/ColorMatrixFilters.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrixFilters.ts#L54) +Defined in: [src/filters/ColorMatrixFilters.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrixFilters.ts#L54) diff --git a/src/content/docs/api/fabric/namespaces/filters/variables/Vintage.md b/src/content/docs/api/fabric/namespaces/filters/variables/Vintage.md index 8133f9e4..f2753e90 100644 --- a/src/content/docs/api/fabric/namespaces/filters/variables/Vintage.md +++ b/src/content/docs/api/fabric/namespaces/filters/variables/Vintage.md @@ -7,4 +7,4 @@ title: "Vintage" > `const` **Vintage**: *typeof* [`ColorMatrix`](/api/fabric/namespaces/filters/classes/colormatrix/) -Defined in: [src/filters/ColorMatrixFilters.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/ColorMatrixFilters.ts#L38) +Defined in: [src/filters/ColorMatrixFilters.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/ColorMatrixFilters.ts#L38) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/addTransformToObject.md b/src/content/docs/api/fabric/namespaces/util/functions/addTransformToObject.md index d2ccfebe..835aed35 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/addTransformToObject.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/addTransformToObject.md @@ -7,7 +7,7 @@ title: "addTransformToObject" > **addTransformToObject**(`object`, `transform`): `void` -Defined in: [src/util/misc/objectTransforms.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectTransforms.ts#L43) +Defined in: [src/util/misc/objectTransforms.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectTransforms.ts#L43) given an object and a transform, apply the transform to the object. this is equivalent to change the space where the object is drawn. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/animate.md b/src/content/docs/api/fabric/namespaces/util/functions/animate.md index a91d8b8f..614dcae4 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/animate.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/animate.md @@ -9,7 +9,7 @@ title: "animate" > **animate**(`options`): `ArrayAnimation` -Defined in: [src/util/animation/animate.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/animate.ts#L50) +Defined in: [src/util/animation/animate.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/animate.ts#L50) Changes value(s) from startValue to endValue within a certain period of time, invoking callbacks as the value(s) change. @@ -54,7 +54,7 @@ animate({ > **animate**(`options`): `ValueAnimation` -Defined in: [src/util/animation/animate.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/animate.ts#L51) +Defined in: [src/util/animation/animate.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/animate.ts#L51) Changes value(s) from startValue to endValue within a certain period of time, invoking callbacks as the value(s) change. @@ -99,7 +99,7 @@ animate({ > **animate**\<`T`\>(`options`): `T` *extends* `Partial`\<[`TAnimationBaseOptions`](/api/fabric/namespaces/util/type-aliases/tanimationbaseoptions/)\<`number`[]\> & [`TAnimationCallbacks`](/api/fabric/namespaces/util/type-aliases/tanimationcallbacks/)\<`number`[]\> & `object`\> ? `ArrayAnimation` : `ValueAnimation` -Defined in: [src/util/animation/animate.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/animate.ts#L52) +Defined in: [src/util/animation/animate.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/animate.ts#L52) Changes value(s) from startValue to endValue within a certain period of time, invoking callbacks as the value(s) change. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/animateColor.md b/src/content/docs/api/fabric/namespaces/util/functions/animateColor.md index e8deec97..9a717ad8 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/animateColor.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/animateColor.md @@ -7,7 +7,7 @@ title: "animateColor" > **animateColor**(`options`): `ColorAnimation` -Defined in: [src/util/animation/animate.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/animate.ts#L70) +Defined in: [src/util/animation/animate.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/animate.ts#L70) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/applyTransformToObject.md b/src/content/docs/api/fabric/namespaces/util/functions/applyTransformToObject.md index 3f4566ff..03982a35 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/applyTransformToObject.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/applyTransformToObject.md @@ -7,7 +7,7 @@ title: "applyTransformToObject" > **applyTransformToObject**(`object`, `transform`): `void` -Defined in: [src/util/misc/objectTransforms.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectTransforms.ts#L54) +Defined in: [src/util/misc/objectTransforms.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectTransforms.ts#L54) discard an object transform state and apply the one from the matrix. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/calcAngleBetweenVectors.md b/src/content/docs/api/fabric/namespaces/util/functions/calcAngleBetweenVectors.md index 512fdb0e..d1245437 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/calcAngleBetweenVectors.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/calcAngleBetweenVectors.md @@ -7,7 +7,7 @@ title: "calcAngleBetweenVectors" > **calcAngleBetweenVectors**(`a`, `b`): [`TRadian`](/api/type-aliases/tradian/) -Defined in: [src/util/misc/vectors.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L39) +Defined in: [src/util/misc/vectors.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L39) Calculates the angle between 2 vectors diff --git a/src/content/docs/api/fabric/namespaces/util/functions/calcDimensionsMatrix.md b/src/content/docs/api/fabric/namespaces/util/functions/calcDimensionsMatrix.md index d1ea8dda..51b29c2d 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/calcDimensionsMatrix.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/calcDimensionsMatrix.md @@ -7,7 +7,7 @@ title: "calcDimensionsMatrix" > **calcDimensionsMatrix**(`options`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:274](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L274) +Defined in: [src/util/misc/matrix.ts:290](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L290) Returns a transform matrix starting from an object of the same kind of the one returned from qrDecompose, useful also if you want to calculate some diff --git a/src/content/docs/api/fabric/namespaces/util/functions/calcPlaneChangeMatrix.md b/src/content/docs/api/fabric/namespaces/util/functions/calcPlaneChangeMatrix.md index 60be5b18..4f3efb33 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/calcPlaneChangeMatrix.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/calcPlaneChangeMatrix.md @@ -7,7 +7,7 @@ title: "calcPlaneChangeMatrix" > **calcPlaneChangeMatrix**(`from?`, `to?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/planeChange.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/planeChange.ts#L15) +Defined in: [src/util/misc/planeChange.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/planeChange.ts#L15) We are actually looking for the transformation from the destination plane to the source plane (change of basis matrix)\ The object will exist on the destination plane and we want it to seem unchanged by it so we invert the destination matrix (`to`) and then apply the source matrix (`from`) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/calcVectorRotation.md b/src/content/docs/api/fabric/namespaces/util/functions/calcVectorRotation.md index 8275ca22..bb85e84a 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/calcVectorRotation.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/calcVectorRotation.md @@ -7,7 +7,7 @@ title: "calcVectorRotation" > **calcVectorRotation**(`v`): [`TRadian`](/api/type-aliases/tradian/) -Defined in: [src/util/misc/vectors.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L47) +Defined in: [src/util/misc/vectors.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L47) Calculates the angle between the x axis and the vector diff --git a/src/content/docs/api/fabric/namespaces/util/functions/cancelAnimFrame.md b/src/content/docs/api/fabric/namespaces/util/functions/cancelAnimFrame.md index 836a21a7..88159004 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/cancelAnimFrame.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/cancelAnimFrame.md @@ -7,7 +7,7 @@ title: "cancelAnimFrame" > **cancelAnimFrame**(`handle`): `void` -Defined in: [src/util/animation/AnimationFrameProvider.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/AnimationFrameProvider.ts#L7) +Defined in: [src/util/animation/AnimationFrameProvider.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/AnimationFrameProvider.ts#L7) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/capValue.md b/src/content/docs/api/fabric/namespaces/util/functions/capValue.md index 2a1d4e5e..d6208fc3 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/capValue.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/capValue.md @@ -7,7 +7,7 @@ title: "capValue" > **capValue**(`min`, `value`, `max`): `number` -Defined in: [src/util/misc/capValue.ts:1](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/capValue.ts#L1) +Defined in: [src/util/misc/capValue.ts:1](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/capValue.ts#L1) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/composeMatrix.md b/src/content/docs/api/fabric/namespaces/util/functions/composeMatrix.md index 6aa48376..47021a7e 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/composeMatrix.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/composeMatrix.md @@ -7,7 +7,7 @@ title: "composeMatrix" > **composeMatrix**(`options`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:312](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L312) +Defined in: [src/util/misc/matrix.ts:328](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L328) Returns a transform matrix starting from an object of the same kind of the one returned from qrDecompose, useful also if you want to calculate some diff --git a/src/content/docs/api/fabric/namespaces/util/functions/copyCanvasElement.md b/src/content/docs/api/fabric/namespaces/util/functions/copyCanvasElement.md index 8a47222a..a2181621 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/copyCanvasElement.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/copyCanvasElement.md @@ -7,7 +7,7 @@ title: "copyCanvasElement" > **copyCanvasElement**(`canvas`): `HTMLCanvasElement` -Defined in: [src/util/misc/dom.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/dom.ts#L28) +Defined in: [src/util/misc/dom.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/dom.ts#L28) Creates a canvas element that is a copy of another and is also painted diff --git a/src/content/docs/api/fabric/namespaces/util/functions/cos.md b/src/content/docs/api/fabric/namespaces/util/functions/cos.md index a3b4a988..e6590d7a 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/cos.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/cos.md @@ -7,7 +7,7 @@ title: "cos" > **cos**(`angle`): `number` -Defined in: [src/util/misc/cos.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/cos.ts#L11) +Defined in: [src/util/misc/cos.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/cos.ts#L11) Calculate the cos of an angle, avoiding returning floats for known results This function is here just to avoid getting 0.999999999999999 when dealing diff --git a/src/content/docs/api/fabric/namespaces/util/functions/createCanvasElement.md b/src/content/docs/api/fabric/namespaces/util/functions/createCanvasElement.md index 56bd430d..d65a430e 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/createCanvasElement.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/createCanvasElement.md @@ -7,7 +7,7 @@ title: "createCanvasElement" > **createCanvasElement**(): `HTMLCanvasElement` -Defined in: [src/util/misc/dom.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/dom.ts#L8) +Defined in: [src/util/misc/dom.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/dom.ts#L8) Creates canvas element diff --git a/src/content/docs/api/fabric/namespaces/util/functions/createImage.md b/src/content/docs/api/fabric/namespaces/util/functions/createImage.md index fe987916..53347999 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/createImage.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/createImage.md @@ -7,7 +7,7 @@ title: "createImage" > **createImage**(): `HTMLImageElement` -Defined in: [src/util/misc/dom.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/dom.ts#L20) +Defined in: [src/util/misc/dom.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/dom.ts#L20) Creates image element (works on client and node) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/createRotateMatrix.md b/src/content/docs/api/fabric/namespaces/util/functions/createRotateMatrix.md index a824b892..ecac2730 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/createRotateMatrix.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/createRotateMatrix.md @@ -7,7 +7,7 @@ title: "createRotateMatrix" > **createRotateMatrix**(`angle`, `pivotPoint?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:169](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L169) +Defined in: [src/util/misc/matrix.ts:185](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L185) Generate a rotation matrix around around a point (x,y), defaulting to (0,0) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/createScaleMatrix.md b/src/content/docs/api/fabric/namespaces/util/functions/createScaleMatrix.md index 7ff54caf..d61928c9 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/createScaleMatrix.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/createScaleMatrix.md @@ -7,7 +7,7 @@ title: "createScaleMatrix" > **createScaleMatrix**(`x`, `y?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:200](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L200) +Defined in: [src/util/misc/matrix.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L216) Generate a scale matrix around the point (0,0) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/createSkewXMatrix.md b/src/content/docs/api/fabric/namespaces/util/functions/createSkewXMatrix.md index db74558a..3f284a3a 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/createSkewXMatrix.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/createSkewXMatrix.md @@ -7,7 +7,7 @@ title: "createSkewXMatrix" > **createSkewXMatrix**(`skewValue`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:228](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L228) +Defined in: [src/util/misc/matrix.ts:244](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L244) Generate a skew matrix for the X axis diff --git a/src/content/docs/api/fabric/namespaces/util/functions/createSkewYMatrix.md b/src/content/docs/api/fabric/namespaces/util/functions/createSkewYMatrix.md index eb944f10..16470b81 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/createSkewYMatrix.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/createSkewYMatrix.md @@ -7,7 +7,7 @@ title: "createSkewYMatrix" > **createSkewYMatrix**(`skewValue`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:250](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L250) +Defined in: [src/util/misc/matrix.ts:266](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L266) Generate a skew matrix for the Y axis diff --git a/src/content/docs/api/fabric/namespaces/util/functions/createTranslateMatrix.md b/src/content/docs/api/fabric/namespaces/util/functions/createTranslateMatrix.md index 3a7a53ca..428918d5 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/createTranslateMatrix.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/createTranslateMatrix.md @@ -7,7 +7,7 @@ title: "createTranslateMatrix" > **createTranslateMatrix**(`x`, `y?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:147](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L147) +Defined in: [src/util/misc/matrix.ts:163](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L163) Generate a translation matrix diff --git a/src/content/docs/api/fabric/namespaces/util/functions/createVector.md b/src/content/docs/api/fabric/namespaces/util/functions/createVector.md index 0622c4ea..58ed1c5f 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/createVector.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/createVector.md @@ -7,7 +7,7 @@ title: "createVector" > **createVector**(`from`, `to`): [`Point`](/api/classes/point/) -Defined in: [src/util/misc/vectors.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L24) +Defined in: [src/util/misc/vectors.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L24) Creates a vector from points represented as a point diff --git a/src/content/docs/api/fabric/namespaces/util/functions/crossProduct.md b/src/content/docs/api/fabric/namespaces/util/functions/crossProduct.md index 663b3d86..9fbb28cc 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/crossProduct.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/crossProduct.md @@ -7,7 +7,7 @@ title: "crossProduct" > **crossProduct**(`a`, `b`): `number` -Defined in: [src/util/misc/vectors.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L74) +Defined in: [src/util/misc/vectors.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L74) Cross product of two vectors in 2D diff --git a/src/content/docs/api/fabric/namespaces/util/functions/degreesToRadians.md b/src/content/docs/api/fabric/namespaces/util/functions/degreesToRadians.md index 72060665..73b6d4f9 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/degreesToRadians.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/degreesToRadians.md @@ -7,7 +7,7 @@ title: "degreesToRadians" > **degreesToRadians**(`degrees`): [`TRadian`](/api/type-aliases/tradian/) -Defined in: [src/util/misc/radiansDegreesConversion.ts:9](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/radiansDegreesConversion.ts#L9) +Defined in: [src/util/misc/radiansDegreesConversion.ts:9](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/radiansDegreesConversion.ts#L9) Transforms degrees to radians. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/dotProduct.md b/src/content/docs/api/fabric/namespaces/util/functions/dotProduct.md index ca5725ad..a84be509 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/dotProduct.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/dotProduct.md @@ -7,7 +7,7 @@ title: "dotProduct" > **dotProduct**(`a`, `b`): `number` -Defined in: [src/util/misc/vectors.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L83) +Defined in: [src/util/misc/vectors.ts:83](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L83) Dot product of two vectors in 2D diff --git a/src/content/docs/api/fabric/namespaces/util/functions/enlivenObjectEnlivables.md b/src/content/docs/api/fabric/namespaces/util/functions/enlivenObjectEnlivables.md index 3b18b0d8..13fd1670 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/enlivenObjectEnlivables.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/enlivenObjectEnlivables.md @@ -7,7 +7,7 @@ title: "enlivenObjectEnlivables" > **enlivenObjectEnlivables**\<`R`\>(`serializedObject`, `options?`): `Promise`\<`R`\> -Defined in: [src/util/misc/objectEnlive.ts:143](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectEnlive.ts#L143) +Defined in: [src/util/misc/objectEnlive.ts:157](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectEnlive.ts#L157) Creates corresponding fabric instances residing in an object, e.g. `clipPath` diff --git a/src/content/docs/api/fabric/namespaces/util/functions/enlivenObjects.md b/src/content/docs/api/fabric/namespaces/util/functions/enlivenObjects.md index d4571f37..5cc85655 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/enlivenObjects.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/enlivenObjects.md @@ -7,7 +7,7 @@ title: "enlivenObjects" > **enlivenObjects**\<`T`\>(`objects`, `options?`): `Promise`\<`T`[]\> -Defined in: [src/util/misc/objectEnlive.ts:92](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectEnlive.ts#L92) +Defined in: [src/util/misc/objectEnlive.ts:93](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectEnlive.ts#L93) ## Type Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/findScaleToCover.md b/src/content/docs/api/fabric/namespaces/util/functions/findScaleToCover.md index 99689b89..a9c7645f 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/findScaleToCover.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/findScaleToCover.md @@ -7,7 +7,7 @@ title: "findScaleToCover" > **findScaleToCover**(`source`, `destination`): `number` -Defined in: [src/util/misc/findScaleTo.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/findScaleTo.ts#L25) +Defined in: [src/util/misc/findScaleTo.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/findScaleTo.ts#L25) Finds the scale for the object source to cover entirely the object destination, keeping aspect ratio intact. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/findScaleToFit.md b/src/content/docs/api/fabric/namespaces/util/functions/findScaleToFit.md index a89f93a7..20621e00 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/findScaleToFit.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/findScaleToFit.md @@ -7,7 +7,7 @@ title: "findScaleToFit" > **findScaleToFit**(`source`, `destination`): `number` -Defined in: [src/util/misc/findScaleTo.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/findScaleTo.ts#L11) +Defined in: [src/util/misc/findScaleTo.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/findScaleTo.ts#L11) Finds the scale for the object source to fit inside the object destination, keeping aspect ratio intact. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getBoundsOfCurve.md b/src/content/docs/api/fabric/namespaces/util/functions/getBoundsOfCurve.md index 055e0da8..0dbb86d7 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getBoundsOfCurve.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getBoundsOfCurve.md @@ -7,7 +7,7 @@ title: "getBoundsOfCurve" > **getBoundsOfCurve**(`begx`, `begy`, `cp1x`, `cp1y`, `cp2x`, `cp2y`, `endx`, `endy`): [`TRectBounds`](/api/type-aliases/trectbounds/) -Defined in: [src/util/path/index.ts:221](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/index.ts#L221) +Defined in: [src/util/path/index.ts:221](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/index.ts#L221) Calculate bounding box of a cubic Bezier curve Taken from http://jsbin.com/ivomiq/56/edit (no credits available) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getOrthonormalVector.md b/src/content/docs/api/fabric/namespaces/util/functions/getOrthonormalVector.md index 4a1345aa..ab8c92c4 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getOrthonormalVector.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getOrthonormalVector.md @@ -7,7 +7,7 @@ title: "getOrthonormalVector" > **getOrthonormalVector**(`v`, `counterClockwise?`): [`Point`](/api/classes/point/) -Defined in: [src/util/misc/vectors.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L62) +Defined in: [src/util/misc/vectors.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L62) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getPathSegmentsInfo.md b/src/content/docs/api/fabric/namespaces/util/functions/getPathSegmentsInfo.md index 181bd1ad..40afd488 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getPathSegmentsInfo.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getPathSegmentsInfo.md @@ -7,7 +7,7 @@ title: "getPathSegmentsInfo" > **getPathSegmentsInfo**(`path`): [`TPathSegmentInfo`](/api/type-aliases/tpathsegmentinfo/)[] -Defined in: [src/util/path/index.ts:682](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/index.ts#L682) +Defined in: [src/util/path/index.ts:682](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/index.ts#L682) Run over a parsed and simplified path and extract some information (length of each command and starting point) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getPointOnPath.md b/src/content/docs/api/fabric/namespaces/util/functions/getPointOnPath.md index 43de8622..bbe736b2 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getPointOnPath.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getPointOnPath.md @@ -7,7 +7,7 @@ title: "getPointOnPath" > **getPointOnPath**(`path`, `distance`, `infos`): `undefined` \| [`TPointAngle`](/api/type-aliases/tpointangle/) -Defined in: [src/util/path/index.ts:790](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/index.ts#L790) +Defined in: [src/util/path/index.ts:790](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/index.ts#L790) Get the point on the path that is distance along the path diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getPointer.md b/src/content/docs/api/fabric/namespaces/util/functions/getPointer.md index 979433f0..285d504e 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getPointer.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getPointer.md @@ -7,7 +7,7 @@ title: "getPointer" > **getPointer**(`event`): [`Point`](/api/classes/point/) -Defined in: [src/util/dom\_event.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/dom_event.ts#L15) +Defined in: [src/util/dom\_event.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/dom_event.ts#L15) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getRandomInt.md b/src/content/docs/api/fabric/namespaces/util/functions/getRandomInt.md index 348c6589..53feae83 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getRandomInt.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getRandomInt.md @@ -7,7 +7,7 @@ title: "getRandomInt" > **getRandomInt**(`min`, `max`): `number` -Defined in: [src/util/internals/getRandomInt.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/internals/getRandomInt.ts#L7) +Defined in: [src/util/internals/getRandomInt.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/internals/getRandomInt.ts#L7) Returns random number between 2 specified ones. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getRegularPolygonPath.md b/src/content/docs/api/fabric/namespaces/util/functions/getRegularPolygonPath.md index 7ee83499..990d798c 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getRegularPolygonPath.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getRegularPolygonPath.md @@ -7,7 +7,7 @@ title: "getRegularPolygonPath" > **getRegularPolygonPath**(`numVertexes`, `radius`): [`TSimplePathData`](/api/type-aliases/tsimplepathdata/) -Defined in: [src/util/path/index.ts:1005](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/index.ts#L1005) +Defined in: [src/util/path/index.ts:1006](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/index.ts#L1006) Returns an array of path commands to create a regular polygon diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getSmoothPathFromPoints.md b/src/content/docs/api/fabric/namespaces/util/functions/getSmoothPathFromPoints.md index 488d2704..169b0b05 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getSmoothPathFromPoints.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getSmoothPathFromPoints.md @@ -7,7 +7,7 @@ title: "getSmoothPathFromPoints" > **getSmoothPathFromPoints**(`points`, `correction?`): [`TSimplePathData`](/api/type-aliases/tsimplepathdata/) -Defined in: [src/util/path/index.ts:910](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/index.ts#L910) +Defined in: [src/util/path/index.ts:911](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/index.ts#L911) Converts points to a smooth SVG path diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getSvgAttributes.md b/src/content/docs/api/fabric/namespaces/util/functions/getSvgAttributes.md index 0c9e3198..c954279f 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getSvgAttributes.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getSvgAttributes.md @@ -7,7 +7,7 @@ title: "getSvgAttributes" > **getSvgAttributes**(`type`): `string`[] -Defined in: [src/util/misc/svgParsing.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/svgParsing.ts#L13) +Defined in: [src/util/misc/svgParsing.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/svgParsing.ts#L19) Returns array of attributes for given svg that fabric parses diff --git a/src/content/docs/api/fabric/namespaces/util/functions/getUnitVector.md b/src/content/docs/api/fabric/namespaces/util/functions/getUnitVector.md index 9d86c525..d303201a 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/getUnitVector.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/getUnitVector.md @@ -7,7 +7,7 @@ title: "getUnitVector" > **getUnitVector**(`v`): [`Point`](/api/classes/point/) -Defined in: [src/util/misc/vectors.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L54) +Defined in: [src/util/misc/vectors.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L54) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/groupSVGElements.md b/src/content/docs/api/fabric/namespaces/util/functions/groupSVGElements.md index ef801a0e..04167073 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/groupSVGElements.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/groupSVGElements.md @@ -7,7 +7,7 @@ title: "groupSVGElements" > **groupSVGElements**(`elements`, `options?`): [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/util/misc/groupSVGElements.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/groupSVGElements.ts#L11) +Defined in: [src/util/misc/groupSVGElements.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/groupSVGElements.ts#L11) TODO experiment with different layout manager and svg results ( fixed fit content ) Groups SVG elements (usually those retrieved from SVG document) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/hasStyleChanged.md b/src/content/docs/api/fabric/namespaces/util/functions/hasStyleChanged.md index 4aa59a0e..d82d64f7 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/hasStyleChanged.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/hasStyleChanged.md @@ -7,7 +7,7 @@ title: "hasStyleChanged" > **hasStyleChanged**(`prevStyle`, `thisStyle`, `forTextSpans`): `boolean` -Defined in: [src/util/misc/textStyles.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/textStyles.ts#L21) +Defined in: [src/util/misc/textStyles.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/textStyles.ts#L21) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/invertTransform.md b/src/content/docs/api/fabric/namespaces/util/functions/invertTransform.md index e4675684..adb183c4 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/invertTransform.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/invertTransform.md @@ -7,7 +7,7 @@ title: "invertTransform" > **invertTransform**(`t`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L57) +Defined in: [src/util/misc/matrix.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L57) Invert transformation t diff --git a/src/content/docs/api/fabric/namespaces/util/functions/isBetweenVectors.md b/src/content/docs/api/fabric/namespaces/util/functions/isBetweenVectors.md index 811accb3..87217fb0 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/isBetweenVectors.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/isBetweenVectors.md @@ -7,7 +7,7 @@ title: "isBetweenVectors" > **isBetweenVectors**(`t`, `a`, `b`): `boolean` -Defined in: [src/util/misc/vectors.ts:94](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L94) +Defined in: [src/util/misc/vectors.ts:94](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L94) Checks if the vector is between two others. It is considered to be inside when the vector to be tested is between the diff --git a/src/content/docs/api/fabric/namespaces/util/functions/isIdentityMatrix.md b/src/content/docs/api/fabric/namespaces/util/functions/isIdentityMatrix.md index 4fff76ef..a93a4778 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/isIdentityMatrix.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/isIdentityMatrix.md @@ -7,7 +7,7 @@ title: "isIdentityMatrix" > **isIdentityMatrix**(`mat`): `boolean` -Defined in: [src/util/misc/matrix.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L35) +Defined in: [src/util/misc/matrix.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L35) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/isTouchEvent.md b/src/content/docs/api/fabric/namespaces/util/functions/isTouchEvent.md index 0ef3e480..2b0afac9 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/isTouchEvent.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/isTouchEvent.md @@ -7,7 +7,7 @@ title: "isTouchEvent" > **isTouchEvent**(`event`): `boolean` -Defined in: [src/util/dom\_event.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/dom_event.ts#L22) +Defined in: [src/util/dom\_event.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/dom_event.ts#L22) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/isTransparent.md b/src/content/docs/api/fabric/namespaces/util/functions/isTransparent.md index 6eb786f3..90c40919 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/isTransparent.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/isTransparent.md @@ -7,7 +7,7 @@ title: "isTransparent" > **isTransparent**(`ctx`, `x`, `y`, `tolerance`): `boolean` -Defined in: [src/util/misc/isTransparent.ts:10](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/isTransparent.ts#L10) +Defined in: [src/util/misc/isTransparent.ts:10](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/isTransparent.ts#L10) Returns true if context has transparent pixel at specified location (taking tolerance into account) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/joinPath.md b/src/content/docs/api/fabric/namespaces/util/functions/joinPath.md index ff818b2d..7e4f3ce0 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/joinPath.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/joinPath.md @@ -7,7 +7,7 @@ title: "joinPath" > **joinPath**(`pathData`, `fractionDigits?`): `string` -Defined in: [src/util/path/index.ts:1032](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/index.ts#L1032) +Defined in: [src/util/path/index.ts:1033](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/index.ts#L1033) Join path commands to go back to svg format diff --git a/src/content/docs/api/fabric/namespaces/util/functions/loadImage.md b/src/content/docs/api/fabric/namespaces/util/functions/loadImage.md index 957978a1..65641199 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/loadImage.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/loadImage.md @@ -7,7 +7,7 @@ title: "loadImage" > **loadImage**(`url`, `options?`): `Promise`\<`HTMLImageElement`\> -Defined in: [src/util/misc/objectEnlive.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectEnlive.ts#L29) +Defined in: [src/util/misc/objectEnlive.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectEnlive.ts#L29) Loads image element from given url and resolve it, or catch. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/magnitude.md b/src/content/docs/api/fabric/namespaces/util/functions/magnitude.md index b4659e45..c77f56dd 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/magnitude.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/magnitude.md @@ -7,7 +7,7 @@ title: "magnitude" > **magnitude**(`point`): `number` -Defined in: [src/util/misc/vectors.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L31) +Defined in: [src/util/misc/vectors.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L31) return the magnitude of a vector diff --git a/src/content/docs/api/fabric/namespaces/util/functions/makeBoundingBoxFromPoints.md b/src/content/docs/api/fabric/namespaces/util/functions/makeBoundingBoxFromPoints.md index 41578207..2b0b72a7 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/makeBoundingBoxFromPoints.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/makeBoundingBoxFromPoints.md @@ -7,7 +7,7 @@ title: "makeBoundingBoxFromPoints" > **makeBoundingBoxFromPoints**(`points`): [`TBBox`](/api/type-aliases/tbbox/) -Defined in: [src/util/misc/boundingBoxFromPoints.ts:9](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/boundingBoxFromPoints.ts#L9) +Defined in: [src/util/misc/boundingBoxFromPoints.ts:9](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/boundingBoxFromPoints.ts#L9) Calculates bounding box (left, top, width, height) from given `points` diff --git a/src/content/docs/api/fabric/namespaces/util/functions/makePathSimpler.md b/src/content/docs/api/fabric/namespaces/util/functions/makePathSimpler.md index 233da5d6..f814bd1b 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/makePathSimpler.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/makePathSimpler.md @@ -7,7 +7,7 @@ title: "makePathSimpler" > **makePathSimpler**(`path`): [`TSimplePathData`](/api/type-aliases/tsimplepathdata/) -Defined in: [src/util/path/index.ts:351](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/index.ts#L351) +Defined in: [src/util/path/index.ts:351](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/index.ts#L351) This function takes a parsed SVG path and makes it simpler for fabricJS logic. Simplification consist of: diff --git a/src/content/docs/api/fabric/namespaces/util/functions/matrixToSVG.md b/src/content/docs/api/fabric/namespaces/util/functions/matrixToSVG.md index 5a45030c..4324ed6d 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/matrixToSVG.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/matrixToSVG.md @@ -7,7 +7,7 @@ title: "matrixToSVG" > **matrixToSVG**(`transform`): `string` -Defined in: [src/util/misc/svgExport.ts:10](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/svgExport.ts#L10) +Defined in: [src/util/misc/svgExport.ts:10](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/svgExport.ts#L10) given an array of 6 number returns something like `"matrix(...numbers)"` diff --git a/src/content/docs/api/fabric/namespaces/util/functions/mergeClipPaths.md b/src/content/docs/api/fabric/namespaces/util/functions/mergeClipPaths.md index ebfc7d43..5741f871 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/mergeClipPaths.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/mergeClipPaths.md @@ -7,12 +7,12 @@ title: "mergeClipPaths" > **mergeClipPaths**(`c1`, `c2`): [`Group`](/api/classes/group/) -Defined in: [src/util/misc/mergeClipPaths.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/mergeClipPaths.ts#L22) +Defined in: [src/util/misc/mergeClipPaths.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/mergeClipPaths.ts#L22) Merges 2 clip paths into one visually equal clip path **IMPORTANT**:\ -Does **NOT** clone the arguments, clone them proir if necessary. +Does **NOT** clone the arguments, clone them prior if necessary. Creates a wrapper (group) that contains one clip path and is clipped by the other so content is kept where both overlap. Use this method if both the clip paths may have nested clip paths of their own, so assigning one to the other's clip path property is not possible. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/multiplyTransformMatrices.md b/src/content/docs/api/fabric/namespaces/util/functions/multiplyTransformMatrices.md index fc0ca5a6..7ad40790 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/multiplyTransformMatrices.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/multiplyTransformMatrices.md @@ -7,7 +7,7 @@ title: "multiplyTransformMatrices" > **multiplyTransformMatrices**(`a`, `b`, `is2x2?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L73) +Defined in: [src/util/misc/matrix.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L73) Multiply matrix A by matrix B to nest transformations diff --git a/src/content/docs/api/fabric/namespaces/util/functions/multiplyTransformMatrixArray.md b/src/content/docs/api/fabric/namespaces/util/functions/multiplyTransformMatrixArray.md index 37c8fe1c..daf15eb0 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/multiplyTransformMatrixArray.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/multiplyTransformMatrixArray.md @@ -7,7 +7,7 @@ title: "multiplyTransformMatrixArray" > **multiplyTransformMatrixArray**(`matrices`, `is2x2?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/matrix.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L96) +Defined in: [src/util/misc/matrix.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L96) Multiplies the matrices array such that a matrix defines the plane for the rest of the matrices **after** it diff --git a/src/content/docs/api/fabric/namespaces/util/functions/parsePath.md b/src/content/docs/api/fabric/namespaces/util/functions/parsePath.md index 3fbefb72..ea89903e 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/parsePath.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/parsePath.md @@ -7,7 +7,7 @@ title: "parsePath" > **parsePath**(`pathString`): [`TComplexPathData`](/api/type-aliases/tcomplexpathdata/) -Defined in: [src/util/path/index.ts:857](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/index.ts#L857) +Defined in: [src/util/path/index.ts:857](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/index.ts#L857) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/parsePreserveAspectRatioAttribute.md b/src/content/docs/api/fabric/namespaces/util/functions/parsePreserveAspectRatioAttribute.md index 8c997bc0..1c47fc6a 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/parsePreserveAspectRatioAttribute.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/parsePreserveAspectRatioAttribute.md @@ -7,7 +7,7 @@ title: "parsePreserveAspectRatioAttribute" > **parsePreserveAspectRatioAttribute**(`attribute`): `TPreserveArParsed` -Defined in: [src/util/misc/svgParsing.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/svgParsing.ts#L104) +Defined in: [src/util/misc/svgParsing.ts:110](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/svgParsing.ts#L110) Parse preserveAspectRatio attribute from element https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio diff --git a/src/content/docs/api/fabric/namespaces/util/functions/parseUnit.md b/src/content/docs/api/fabric/namespaces/util/functions/parseUnit.md index 0ab33cf1..d30a94dd 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/parseUnit.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/parseUnit.md @@ -7,7 +7,7 @@ title: "parseUnit" > **parseUnit**(`value`, `fontSize`): `number` -Defined in: [src/util/misc/svgParsing.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/svgParsing.ts#L49) +Defined in: [src/util/misc/svgParsing.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/svgParsing.ts#L55) Converts from attribute value to pixel value if applicable. Returns converted pixels or original value not converted. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/pick.md b/src/content/docs/api/fabric/namespaces/util/functions/pick.md index a6e46d9e..112fcdbe 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/pick.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/pick.md @@ -7,7 +7,7 @@ title: "pick" > **pick**\<`T`\>(`source`, `keys`): `Partial`\<`T`\> -Defined in: [src/util/misc/pick.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/pick.ts#L7) +Defined in: [src/util/misc/pick.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/pick.ts#L7) Populates an object with properties of another object diff --git a/src/content/docs/api/fabric/namespaces/util/functions/projectStrokeOnPoints.md b/src/content/docs/api/fabric/namespaces/util/functions/projectStrokeOnPoints.md index ea5e5fcd..383a6e37 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/projectStrokeOnPoints.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/projectStrokeOnPoints.md @@ -7,7 +7,7 @@ title: "projectStrokeOnPoints" > **projectStrokeOnPoints**(`points`, `options`, `openPath`): [`TProjection`](/api/fabric/namespaces/util/type-aliases/tprojection/)[] -Defined in: [src/util/misc/projectStroke/index.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/index.ts#L16) +Defined in: [src/util/misc/projectStroke/index.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/index.ts#L16) Used to calculate object's bounding box diff --git a/src/content/docs/api/fabric/namespaces/util/functions/qrDecompose.md b/src/content/docs/api/fabric/namespaces/util/functions/qrDecompose.md index 0c8d326a..8006fe08 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/qrDecompose.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/qrDecompose.md @@ -7,7 +7,7 @@ title: "qrDecompose" > **qrDecompose**(`a`): [`TQrDecomposeOut`](/api/fabric/namespaces/util/type-aliases/tqrdecomposeout/) -Defined in: [src/util/misc/matrix.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L116) +Defined in: [src/util/misc/matrix.ts:132](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L132) Decomposes standard 2x3 matrix into transform components diff --git a/src/content/docs/api/fabric/namespaces/util/functions/radiansToDegrees.md b/src/content/docs/api/fabric/namespaces/util/functions/radiansToDegrees.md index ee7ce414..8e33087f 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/radiansToDegrees.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/radiansToDegrees.md @@ -7,7 +7,7 @@ title: "radiansToDegrees" > **radiansToDegrees**(`radians`): [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/util/misc/radiansDegreesConversion.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/radiansDegreesConversion.ts#L17) +Defined in: [src/util/misc/radiansDegreesConversion.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/radiansDegreesConversion.ts#L17) Transforms radians to degrees. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/removeFromArray.md b/src/content/docs/api/fabric/namespaces/util/functions/removeFromArray.md index 6c7956ab..d6621d47 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/removeFromArray.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/removeFromArray.md @@ -7,7 +7,7 @@ title: "removeFromArray" > **removeFromArray**\<`T`\>(`array`, `value`): `T`[] -Defined in: [src/util/internals/removeFromArray.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/internals/removeFromArray.ts#L8) +Defined in: [src/util/internals/removeFromArray.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/internals/removeFromArray.ts#L8) Removes value from an array. Presence of value (and its position in an array) is determined via `Array.prototype.indexOf` diff --git a/src/content/docs/api/fabric/namespaces/util/functions/removeTransformFromObject.md b/src/content/docs/api/fabric/namespaces/util/functions/removeTransformFromObject.md index a37c8293..d6d83cbf 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/removeTransformFromObject.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/removeTransformFromObject.md @@ -7,7 +7,7 @@ title: "removeTransformFromObject" > **removeTransformFromObject**(`object`, `transform`): `void` -Defined in: [src/util/misc/objectTransforms.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectTransforms.ts#L23) +Defined in: [src/util/misc/objectTransforms.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectTransforms.ts#L23) given an object and a transform, apply the inverse transform to the object, this is equivalent to remove from that object that transformation, so that diff --git a/src/content/docs/api/fabric/namespaces/util/functions/requestAnimFrame.md b/src/content/docs/api/fabric/namespaces/util/functions/requestAnimFrame.md index 288c11fa..12461792 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/requestAnimFrame.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/requestAnimFrame.md @@ -7,7 +7,7 @@ title: "requestAnimFrame" > **requestAnimFrame**(`callback`): `number` -Defined in: [src/util/animation/AnimationFrameProvider.ts:3](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/AnimationFrameProvider.ts#L3) +Defined in: [src/util/animation/AnimationFrameProvider.ts:3](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/AnimationFrameProvider.ts#L3) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/resetObjectTransform.md b/src/content/docs/api/fabric/namespaces/util/functions/resetObjectTransform.md index 49ddcfd5..f3421211 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/resetObjectTransform.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/resetObjectTransform.md @@ -7,7 +7,7 @@ title: "resetObjectTransform" > **resetObjectTransform**(`target`): `void` -Defined in: [src/util/misc/objectTransforms.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectTransforms.ts#L71) +Defined in: [src/util/misc/objectTransforms.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectTransforms.ts#L71) reset an object transform state to neutral. Top and left are not accounted for diff --git a/src/content/docs/api/fabric/namespaces/util/functions/rotateVector.md b/src/content/docs/api/fabric/namespaces/util/functions/rotateVector.md index dd7bdd64..29db5422 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/rotateVector.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/rotateVector.md @@ -7,7 +7,7 @@ title: "rotateVector" > **rotateVector**(`vector`, `radians`): [`Point`](/api/classes/point/) -Defined in: [src/util/misc/vectors.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/vectors.ts#L14) +Defined in: [src/util/misc/vectors.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/vectors.ts#L14) Rotates `vector` with `radians` diff --git a/src/content/docs/api/fabric/namespaces/util/functions/saveObjectTransform.md b/src/content/docs/api/fabric/namespaces/util/functions/saveObjectTransform.md index 1f1b7682..e3940316 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/saveObjectTransform.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/saveObjectTransform.md @@ -7,7 +7,7 @@ title: "saveObjectTransform" > **saveObjectTransform**(`target`): `object` -Defined in: [src/util/misc/objectTransforms.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectTransforms.ts#L86) +Defined in: [src/util/misc/objectTransforms.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectTransforms.ts#L86) Extract Object transform values diff --git a/src/content/docs/api/fabric/namespaces/util/functions/sendObjectToPlane.md b/src/content/docs/api/fabric/namespaces/util/functions/sendObjectToPlane.md index 93390eca..81698a26 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/sendObjectToPlane.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/sendObjectToPlane.md @@ -7,7 +7,7 @@ title: "sendObjectToPlane" > **sendObjectToPlane**(`object`, `from?`, `to?`): [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/util/misc/planeChange.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/planeChange.ts#L81) +Defined in: [src/util/misc/planeChange.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/planeChange.ts#L81) A util that abstracts applying transform to objects.\ Sends `object` to the destination coordinate plane by applying the relevant transformations.\ diff --git a/src/content/docs/api/fabric/namespaces/util/functions/sendPointToPlane.md b/src/content/docs/api/fabric/namespaces/util/functions/sendPointToPlane.md index 6e09ba45..1fc4548f 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/sendPointToPlane.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/sendPointToPlane.md @@ -7,7 +7,7 @@ title: "sendPointToPlane" > **sendPointToPlane**(`point`, `from?`, `to?`): [`Point`](/api/classes/point/) -Defined in: [src/util/misc/planeChange.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/planeChange.ts#L36) +Defined in: [src/util/misc/planeChange.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/planeChange.ts#L36) Sends a point from the source coordinate plane to the destination coordinate plane.\ From the canvas/viewer's perspective the point remains unchanged. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/sendVectorToPlane.md b/src/content/docs/api/fabric/namespaces/util/functions/sendVectorToPlane.md index b908291e..278c7032 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/sendVectorToPlane.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/sendVectorToPlane.md @@ -7,7 +7,7 @@ title: "sendVectorToPlane" > **sendVectorToPlane**(`point`, `from`, `to`): [`Point`](/api/classes/point/) -Defined in: [src/util/misc/planeChange.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/planeChange.ts#L45) +Defined in: [src/util/misc/planeChange.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/planeChange.ts#L45) See [sendPointToPlane](/api/fabric/namespaces/util/functions/sendpointtoplane/) diff --git a/src/content/docs/api/fabric/namespaces/util/functions/sin.md b/src/content/docs/api/fabric/namespaces/util/functions/sin.md index 765f4138..ef89bb83 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/sin.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/sin.md @@ -7,7 +7,7 @@ title: "sin" > **sin**(`angle`): `number` -Defined in: [src/util/misc/sin.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/sin.ts#L11) +Defined in: [src/util/misc/sin.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/sin.ts#L11) Calculate the cos of an angle, avoiding returning floats for known results This function is here just to avoid getting 0.999999999999999 when dealing diff --git a/src/content/docs/api/fabric/namespaces/util/functions/sizeAfterTransform.md b/src/content/docs/api/fabric/namespaces/util/functions/sizeAfterTransform.md index 0d24f763..ca5d3aea 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/sizeAfterTransform.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/sizeAfterTransform.md @@ -7,7 +7,7 @@ title: "sizeAfterTransform" > **sizeAfterTransform**(`width`, `height`, `t`): [`Point`](/api/classes/point/) -Defined in: [src/util/misc/objectTransforms.ts:107](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectTransforms.ts#L107) +Defined in: [src/util/misc/objectTransforms.ts:107](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectTransforms.ts#L107) given a width and height, return the size of the bounding box that can contains the box with width/height with applied transform. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/stylesFromArray.md b/src/content/docs/api/fabric/namespaces/util/functions/stylesFromArray.md index 0e02dd31..e1283cc5 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/stylesFromArray.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/stylesFromArray.md @@ -7,7 +7,7 @@ title: "stylesFromArray" > **stylesFromArray**(`styles`, `text`): [`TextStyle`](/api/type-aliases/textstyle/) -Defined in: [src/util/misc/textStyles.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/textStyles.ts#L100) +Defined in: [src/util/misc/textStyles.ts:101](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/textStyles.ts#L101) Returns the object form of the styles property with styles that are assigned per character rather than grouped by range. This format is more verbose, and is diff --git a/src/content/docs/api/fabric/namespaces/util/functions/stylesToArray.md b/src/content/docs/api/fabric/namespaces/util/functions/stylesToArray.md index f23bf15b..4577ceb8 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/stylesToArray.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/stylesToArray.md @@ -7,7 +7,7 @@ title: "stylesToArray" > **stylesToArray**(`styles`, `text`): [`TextStyleArray`](/api/fabric/namespaces/util/type-aliases/textstylearray/) -Defined in: [src/util/misc/textStyles.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/textStyles.ts#L49) +Defined in: [src/util/misc/textStyles.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/textStyles.ts#L50) Returns the array form of a text object's inline styles property with styles grouped in ranges rather than per character. This format is less verbose, and is better suited for storage diff --git a/src/content/docs/api/fabric/namespaces/util/functions/toBlob.md b/src/content/docs/api/fabric/namespaces/util/functions/toBlob.md index e6b17293..da5be6e8 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/toBlob.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/toBlob.md @@ -7,7 +7,7 @@ title: "toBlob" > **toBlob**(`canvasEl`, `format?`, `quality?`): `Promise`\<`null` \| `Blob`\> -Defined in: [src/util/misc/dom.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/dom.ts#L70) +Defined in: [src/util/misc/dom.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/dom.ts#L70) ## Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/functions/toDataURL.md b/src/content/docs/api/fabric/namespaces/util/functions/toDataURL.md index f372ea2a..e1be1e6b 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/toDataURL.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/toDataURL.md @@ -7,7 +7,7 @@ title: "toDataURL" > **toDataURL**(`canvasEl`, `format`, `quality`): `string` -Defined in: [src/util/misc/dom.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/dom.ts#L58) +Defined in: [src/util/misc/dom.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/dom.ts#L58) since 2.6.0 moved from canvas instance to utility. possibly useless diff --git a/src/content/docs/api/fabric/namespaces/util/functions/toFixed.md b/src/content/docs/api/fabric/namespaces/util/functions/toFixed.md index f05e6f12..6815f435 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/toFixed.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/toFixed.md @@ -7,7 +7,7 @@ title: "toFixed" > **toFixed**(`number`, `fractionDigits`): `number` -Defined in: [src/util/misc/toFixed.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/toFixed.ts#L7) +Defined in: [src/util/misc/toFixed.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/toFixed.ts#L7) A wrapper around Number#toFixed, which contrary to native method returns number, not string. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/transformPath.md b/src/content/docs/api/fabric/namespaces/util/functions/transformPath.md index 1f6eefbb..acbcb5c8 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/transformPath.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/transformPath.md @@ -7,7 +7,7 @@ title: "transformPath" > **transformPath**(`path`, `transform`, `pathOffset?`): [`TSimplePathData`](/api/type-aliases/tsimplepathdata/) -Defined in: [src/util/path/index.ts:966](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/index.ts#L966) +Defined in: [src/util/path/index.ts:967](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/index.ts#L967) Transform a path by transforming each segment. it has to be a simplified path or it won't work. diff --git a/src/content/docs/api/fabric/namespaces/util/functions/transformPoint.md b/src/content/docs/api/fabric/namespaces/util/functions/transformPoint.md index d6a50e33..aff15949 100644 --- a/src/content/docs/api/fabric/namespaces/util/functions/transformPoint.md +++ b/src/content/docs/api/fabric/namespaces/util/functions/transformPoint.md @@ -7,7 +7,7 @@ title: "transformPoint" > **transformPoint**(`p`, `t`, `ignoreOffset?`): [`Point`](/api/classes/point/) -Defined in: [src/util/misc/matrix.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L46) +Defined in: [src/util/misc/matrix.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L46) Apply transform t to point p diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/defaultEasing.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/defaultEasing.md index 0db79481..6beb88ad 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/defaultEasing.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/defaultEasing.md @@ -7,6 +7,6 @@ title: "defaultEasing" > `const` **defaultEasing**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L36) +Defined in: [src/util/animation/easing.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L36) Default sinusoidal easing diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInBack.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInBack.md index 76d0f683..d4c6beff 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInBack.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInBack.md @@ -7,6 +7,6 @@ title: "easeInBack" > `const` **easeInBack**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:258](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L258) +Defined in: [src/util/animation/easing.ts:258](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L258) Backwards easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInBounce.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInBounce.md index 9cf8c36d..380fcd7c 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInBounce.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInBounce.md @@ -7,6 +7,6 @@ title: "easeInBounce" > `const` **easeInBounce**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:296](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L296) +Defined in: [src/util/animation/easing.ts:296](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L296) Bouncing easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInCirc.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInCirc.md index 8fc51264..e6730f72 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInCirc.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInCirc.md @@ -7,6 +7,6 @@ title: "easeInCirc" > `const` **easeInCirc**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:158](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L158) +Defined in: [src/util/animation/easing.ts:158](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L158) Circular easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInCubic.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInCubic.md index 8ec9e6c7..2c9b434f 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInCubic.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInCubic.md @@ -7,6 +7,6 @@ title: "easeInCubic" > `const` **easeInCubic**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L42) +Defined in: [src/util/animation/easing.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L42) Cubic easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInElastic.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInElastic.md index 6f6f9c52..8b1f4c2d 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInElastic.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInElastic.md @@ -7,6 +7,6 @@ title: "easeInElastic" > `const` **easeInElastic**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:181](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L181) +Defined in: [src/util/animation/easing.ts:181](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L181) Elastic easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInExpo.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInExpo.md index 0b2b088e..82f67890 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInExpo.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInExpo.md @@ -7,6 +7,6 @@ title: "easeInExpo" > `const` **easeInExpo**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:129](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L129) +Defined in: [src/util/animation/easing.ts:129](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L129) Exponential easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutBack.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutBack.md index 5f227602..46938026 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutBack.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutBack.md @@ -7,6 +7,6 @@ title: "easeInOutBack" > `const` **easeInOutBack**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:270](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L270) +Defined in: [src/util/animation/easing.ts:270](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L270) Backwards easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutBounce.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutBounce.md index a860ac7e..a1a81a7b 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutBounce.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutBounce.md @@ -7,6 +7,6 @@ title: "easeInOutBounce" > `const` **easeInOutBounce**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:302](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L302) +Defined in: [src/util/animation/easing.ts:302](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L302) Bouncing easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutCirc.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutCirc.md index d86a43ac..952dae3d 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutCirc.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutCirc.md @@ -7,6 +7,6 @@ title: "easeInOutCirc" > `const` **easeInOutCirc**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:170](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L170) +Defined in: [src/util/animation/easing.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L170) Circular easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutCubic.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutCubic.md index 7da246a1..99864b2f 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutCubic.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutCubic.md @@ -7,6 +7,6 @@ title: "easeInOutCubic" > `const` **easeInOutCubic**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L54) +Defined in: [src/util/animation/easing.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L54) Cubic easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutElastic.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutElastic.md index 80f6a2ee..045eef9f 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutElastic.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutElastic.md @@ -7,6 +7,6 @@ title: "easeInOutElastic" > `const` **easeInOutElastic**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:227](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L227) +Defined in: [src/util/animation/easing.ts:227](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L227) Elastic easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutExpo.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutExpo.md index 8806c416..391a6fae 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutExpo.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutExpo.md @@ -7,6 +7,6 @@ title: "easeInOutExpo" > `const` **easeInOutExpo**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:141](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L141) +Defined in: [src/util/animation/easing.ts:141](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L141) Exponential easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuad.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuad.md index 5442f061..fa2b44be 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuad.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuad.md @@ -7,6 +7,6 @@ title: "easeInOutQuad" > `const` **easeInOutQuad**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L321) +Defined in: [src/util/animation/easing.ts:321](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L321) Quadratic easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuart.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuart.md index 47ab0b33..38b7db55 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuart.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuart.md @@ -7,6 +7,6 @@ title: "easeInOutQuart" > `const` **easeInOutQuart**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L77) +Defined in: [src/util/animation/easing.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L77) Quartic easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuint.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuint.md index 9c426b7b..8b7160a6 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuint.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutQuint.md @@ -7,6 +7,6 @@ title: "easeInOutQuint" > `const` **easeInOutQuint**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L100) +Defined in: [src/util/animation/easing.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L100) Quintic easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutSine.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutSine.md index c95b2f67..4e05c52b 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutSine.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInOutSine.md @@ -7,6 +7,6 @@ title: "easeInOutSine" > `const` **easeInOutSine**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L123) +Defined in: [src/util/animation/easing.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L123) Sinusoidal easing in and out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuad.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuad.md index 4ae960d3..f8527a34 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuad.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuad.md @@ -7,6 +7,6 @@ title: "easeInQuad" > `const` **easeInQuad**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:310](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L310) +Defined in: [src/util/animation/easing.ts:310](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L310) Quadratic easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuart.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuart.md index b370eb33..8f22e41e 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuart.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuart.md @@ -7,6 +7,6 @@ title: "easeInQuart" > `const` **easeInQuart**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L65) +Defined in: [src/util/animation/easing.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L65) Quartic easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuint.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuint.md index a6db9590..9977d3e4 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuint.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInQuint.md @@ -7,6 +7,6 @@ title: "easeInQuint" > `const` **easeInQuint**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:88](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L88) +Defined in: [src/util/animation/easing.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L88) Quintic easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInSine.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInSine.md index c71a71cd..645b0725 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInSine.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeInSine.md @@ -7,6 +7,6 @@ title: "easeInSine" > `const` **easeInSine**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L111) +Defined in: [src/util/animation/easing.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L111) Sinusoidal easing in diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutBack.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutBack.md index 8fa58158..240056e3 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutBack.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutBack.md @@ -7,6 +7,6 @@ title: "easeOutBack" > `const` **easeOutBack**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:264](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L264) +Defined in: [src/util/animation/easing.ts:264](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L264) Backwards easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutBounce.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutBounce.md index d59ed9a0..b3f20331 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutBounce.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutBounce.md @@ -7,6 +7,6 @@ title: "easeOutBounce" > `const` **easeOutBounce**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:281](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L281) +Defined in: [src/util/animation/easing.ts:281](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L281) Bouncing easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutCirc.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutCirc.md index 75c6d05a..ae1e4193 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutCirc.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutCirc.md @@ -7,6 +7,6 @@ title: "easeOutCirc" > `const` **easeOutCirc**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:164](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L164) +Defined in: [src/util/animation/easing.ts:164](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L164) Circular easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutCubic.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutCubic.md index 5074b232..19eaf787 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutCubic.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutCubic.md @@ -7,6 +7,6 @@ title: "easeOutCubic" > `const` **easeOutCubic**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L48) +Defined in: [src/util/animation/easing.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L48) Cubic easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutElastic.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutElastic.md index 8279c77e..834c703b 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutElastic.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutElastic.md @@ -7,6 +7,6 @@ title: "easeOutElastic" > `const` **easeOutElastic**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L202) +Defined in: [src/util/animation/easing.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L202) Elastic easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutExpo.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutExpo.md index 69c56339..872d3d65 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutExpo.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutExpo.md @@ -7,6 +7,6 @@ title: "easeOutExpo" > `const` **easeOutExpo**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L135) +Defined in: [src/util/animation/easing.ts:135](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L135) Exponential easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuad.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuad.md index 677f28f2..39bd9c35 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuad.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuad.md @@ -7,6 +7,6 @@ title: "easeOutQuad" > `const` **easeOutQuad**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:315](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L315) +Defined in: [src/util/animation/easing.ts:315](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L315) Quadratic easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuart.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuart.md index 0faf8d6e..89f843d2 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuart.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuart.md @@ -7,6 +7,6 @@ title: "easeOutQuart" > `const` **easeOutQuart**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L71) +Defined in: [src/util/animation/easing.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L71) Quartic easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuint.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuint.md index c0218f17..c778bd85 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuint.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutQuint.md @@ -7,6 +7,6 @@ title: "easeOutQuint" > `const` **easeOutQuint**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:94](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L94) +Defined in: [src/util/animation/easing.ts:94](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L94) Quintic easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutSine.md b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutSine.md index 023b63e9..273c21df 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutSine.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/ease/variables/easeOutSine.md @@ -7,6 +7,6 @@ title: "easeOutSine" > `const` **easeOutSine**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/) -Defined in: [src/util/animation/easing.ts:117](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/easing.ts#L117) +Defined in: [src/util/animation/easing.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/easing.ts#L117) Sinusoidal easing out diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/capitalize.md b/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/capitalize.md index d55644e5..83f79175 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/capitalize.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/capitalize.md @@ -7,7 +7,7 @@ title: "capitalize" > **capitalize**(`string`, `firstLetterOnly?`): `string` -Defined in: [src/util/lang\_string.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/lang_string.ts#L11) +Defined in: [src/util/lang\_string.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/lang_string.ts#L11) Capitalizes a string diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/escapeXml.md b/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/escapeXml.md index 1d7ebc9d..a4913957 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/escapeXml.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/escapeXml.md @@ -7,7 +7,7 @@ title: "escapeXml" > **escapeXml**(`stringOrNumber`): `string` -Defined in: [src/util/lang\_string.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/lang_string.ts#L21) +Defined in: [src/util/lang\_string.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/lang_string.ts#L21) Escapes XML in a string diff --git a/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/graphemeSplit.md b/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/graphemeSplit.md index c9236cb5..d5dff629 100644 --- a/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/graphemeSplit.md +++ b/src/content/docs/api/fabric/namespaces/util/namespaces/string/functions/graphemeSplit.md @@ -7,7 +7,7 @@ title: "graphemeSplit" > **graphemeSplit**(`textstring`): `string`[] -Defined in: [src/util/lang\_string.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/lang_string.ts#L49) +Defined in: [src/util/lang\_string.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/lang_string.ts#L49) Divide a string in the user perceived single units diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/AnimationOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/AnimationOptions.md index f3f2fffe..bf71619d 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/AnimationOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/AnimationOptions.md @@ -7,7 +7,7 @@ title: "AnimationOptions" > **AnimationOptions**\<`T`\> = `T` *extends* [`TColorArg`](/api/type-aliases/tcolorarg/) ? [`ColorAnimationOptions`](/api/fabric/namespaces/util/type-aliases/coloranimationoptions/) : `T` *extends* `number`[] ? [`ArrayAnimationOptions`](/api/fabric/namespaces/util/type-aliases/arrayanimationoptions/) : [`ValueAnimationOptions`](/api/fabric/namespaces/util/type-aliases/valueanimationoptions/) -Defined in: [src/util/animation/types.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L131) +Defined in: [src/util/animation/types.ts:131](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L131) ## Type Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/AnimationState.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/AnimationState.md index dc035f7c..6a3d94c0 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/AnimationState.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/AnimationState.md @@ -7,4 +7,4 @@ title: "AnimationState" > **AnimationState** = `"pending"` \| `"running"` \| `"completed"` \| `"aborted"` -Defined in: [src/util/animation/types.ts:3](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L3) +Defined in: [src/util/animation/types.ts:3](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L3) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/ArrayAnimationOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/ArrayAnimationOptions.md index 80702e5a..e0c4aa14 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/ArrayAnimationOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/ArrayAnimationOptions.md @@ -7,4 +7,4 @@ title: "ArrayAnimationOptions" > **ArrayAnimationOptions** = [`TAnimationOptions`](/api/fabric/namespaces/util/type-aliases/tanimationoptions/)\<`number`[]\> -Defined in: [src/util/animation/types.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L123) +Defined in: [src/util/animation/types.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L123) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/ColorAnimationOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/ColorAnimationOptions.md index 14500ea2..2f1be7dd 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/ColorAnimationOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/ColorAnimationOptions.md @@ -7,4 +7,4 @@ title: "ColorAnimationOptions" > **ColorAnimationOptions** = [`TAnimationOptions`](/api/fabric/namespaces/util/type-aliases/tanimationoptions/)\<[`TColorArg`](/api/type-aliases/tcolorarg/), `string`, `number`[]\> -Defined in: [src/util/animation/types.ts:125](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L125) +Defined in: [src/util/animation/types.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L125) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/EnlivenObjectOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/EnlivenObjectOptions.md index 4ff7cb71..1fdb8847 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/EnlivenObjectOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/EnlivenObjectOptions.md @@ -7,13 +7,13 @@ title: "EnlivenObjectOptions" > **EnlivenObjectOptions** = [`Abortable`](/api/type-aliases/abortable/) & `object` -Defined in: [src/util/misc/objectEnlive.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectEnlive.ts#L64) +Defined in: [src/util/misc/objectEnlive.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectEnlive.ts#L64) ## Type Declaration ### reviver()? -> `optional` **reviver**: \<`T`\>(`serializedObj`, `instance`) => `void` +> `optional` **reviver**: \<`T`\>(`serializedObj`, `instance`, `error?`) => `void` \| `Promise`\<`T`\> Method for further parsing of object elements, called after each fabric object created. @@ -32,8 +32,12 @@ called after each fabric object created. ##### instance -`T` +`T` | `undefined` + +##### error? + +`FabricError` #### Returns -`void` +`void` \| `Promise`\<`T`\> diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/LoadImageOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/LoadImageOptions.md index d114c9fd..91b39f7a 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/LoadImageOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/LoadImageOptions.md @@ -7,7 +7,7 @@ title: "LoadImageOptions" > **LoadImageOptions** = [`Abortable`](/api/type-aliases/abortable/) & `object` -Defined in: [src/util/misc/objectEnlive.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/objectEnlive.ts#L16) +Defined in: [src/util/misc/objectEnlive.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/objectEnlive.ts#L16) ## Type Declaration diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAbortCallback.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAbortCallback.md index 875d4490..69fb7c7e 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAbortCallback.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAbortCallback.md @@ -7,7 +7,7 @@ title: "TAbortCallback" > **TAbortCallback**\<`T`\> = [`TOnAnimationChangeCallback`](/api/fabric/namespaces/util/type-aliases/tonanimationchangecallback/)\<`T`, `boolean`\> -Defined in: [src/util/animation/types.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L22) +Defined in: [src/util/animation/types.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L22) Called on each step to determine if animation should abort diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimation.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimation.md index 3b685b4c..a3c48fd7 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimation.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimation.md @@ -7,7 +7,7 @@ title: "TAnimation" > **TAnimation**\<`T`\> = `T` *extends* [`TColorArg`](/api/type-aliases/tcolorarg/) ? `ColorAnimation` : `T` *extends* `number`[] ? `ArrayAnimation` : `ValueAnimation` -Defined in: [src/util/animation/animate.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/animate.ts#L11) +Defined in: [src/util/animation/animate.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/animate.ts#L11) ## Type Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationBaseOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationBaseOptions.md index a40fbf75..f1f22e48 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationBaseOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationBaseOptions.md @@ -7,7 +7,7 @@ title: "TAnimationBaseOptions" > **TAnimationBaseOptions**\<`T`\> = `object` -Defined in: [src/util/animation/types.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L49) +Defined in: [src/util/animation/types.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L49) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [src/util/animation/types.ts:49](https://github.com/fabricjs/fabric. > **delay**: `number` -Defined in: [src/util/animation/types.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L60) +Defined in: [src/util/animation/types.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L60) Delay to start the animation in ms @@ -37,7 +37,7 @@ Delay to start the animation in ms > **duration**: `number` -Defined in: [src/util/animation/types.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L54) +Defined in: [src/util/animation/types.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L54) Duration of the animation in ms @@ -53,7 +53,7 @@ Duration of the animation in ms > **easing**: [`TEasingFunction`](/api/fabric/namespaces/util/type-aliases/teasingfunction/)\<`T`\> -Defined in: [src/util/animation/types.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L66) +Defined in: [src/util/animation/types.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L66) Easing function @@ -69,6 +69,6 @@ Easing function > **target**: `unknown` -Defined in: [src/util/animation/types.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L71) +Defined in: [src/util/animation/types.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L71) The object this animation is being performed on diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationCallbacks.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationCallbacks.md index 127aa898..d20f9273 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationCallbacks.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationCallbacks.md @@ -7,7 +7,7 @@ title: "TAnimationCallbacks" > **TAnimationCallbacks**\<`T`\> = `object` -Defined in: [src/util/animation/types.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L74) +Defined in: [src/util/animation/types.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L74) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [src/util/animation/types.ts:74](https://github.com/fabricjs/fabric. > **abort**: [`TAbortCallback`](/api/fabric/namespaces/util/type-aliases/tabortcallback/)\<`T`\> -Defined in: [src/util/animation/types.ts:94](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L94) +Defined in: [src/util/animation/types.ts:94](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L94) Function called at each frame. If it returns true, abort @@ -32,7 +32,7 @@ If it returns true, abort > **onChange**: [`TOnAnimationChangeCallback`](/api/fabric/namespaces/util/type-aliases/tonanimationchangecallback/)\<`T`\> -Defined in: [src/util/animation/types.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L83) +Defined in: [src/util/animation/types.ts:83](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L83) Called at each frame of the animation @@ -42,7 +42,7 @@ Called at each frame of the animation > **onComplete**: [`TOnAnimationChangeCallback`](/api/fabric/namespaces/util/type-aliases/tonanimationchangecallback/)\<`T`\> -Defined in: [src/util/animation/types.ts:88](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L88) +Defined in: [src/util/animation/types.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L88) Called after the last frame of the animation @@ -52,6 +52,6 @@ Called after the last frame of the animation > **onStart**: `VoidFunction` -Defined in: [src/util/animation/types.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L78) +Defined in: [src/util/animation/types.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L78) Called when the animation starts diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationOptions.md index 81a7a571..35b9804a 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TAnimationOptions.md @@ -7,7 +7,7 @@ title: "TAnimationOptions" > **TAnimationOptions**\<`T`, `TCallback`, `TEasing`\> = `Partial`\<[`TAnimationBaseOptions`](/api/fabric/namespaces/util/type-aliases/tanimationbaseoptions/)\<`TEasing`\> & [`TAnimationCallbacks`](/api/fabric/namespaces/util/type-aliases/tanimationcallbacks/)\<`TCallback`\> & `object`\> -Defined in: [src/util/animation/types.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L104) +Defined in: [src/util/animation/types.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L104) ## Type Parameters diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TBaseAnimationOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TBaseAnimationOptions.md index 8e11a16a..525b78d8 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TBaseAnimationOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TBaseAnimationOptions.md @@ -7,7 +7,7 @@ title: "TBaseAnimationOptions" > **TBaseAnimationOptions**\<`T`, `TCallback`, `TEasing`\> = `Partial`\<[`TAnimationBaseOptions`](/api/fabric/namespaces/util/type-aliases/tanimationbaseoptions/)\<`TEasing`\> & [`TAnimationCallbacks`](/api/fabric/namespaces/util/type-aliases/tanimationcallbacks/)\<`TCallback`\>\> & `object` -Defined in: [src/util/animation/types.ts:97](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L97) +Defined in: [src/util/animation/types.ts:97](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L97) ## Type Declaration diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TComposeMatrixArgs.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TComposeMatrixArgs.md index 9927db5a..9d640c48 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TComposeMatrixArgs.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TComposeMatrixArgs.md @@ -7,4 +7,4 @@ title: "TComposeMatrixArgs" > **TComposeMatrixArgs** = [`TTranslateMatrixArgs`](/api/fabric/namespaces/util/type-aliases/ttranslatematrixargs/) & [`TRotateMatrixArgs`](/api/fabric/namespaces/util/type-aliases/trotatematrixargs/) & [`TScaleMatrixArgs`](/api/fabric/namespaces/util/type-aliases/tscalematrixargs/) -Defined in: [src/util/misc/matrix.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L27) +Defined in: [src/util/misc/matrix.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L27) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TEasingFunction.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TEasingFunction.md index 3d278b3a..89471001 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TEasingFunction.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TEasingFunction.md @@ -7,7 +7,7 @@ title: "TEasingFunction" > **TEasingFunction**\<`T`\> = `T` *extends* `number`[] ? (`timeElapsed`, `startValue`, `byValue`, `duration`, `index`) => `number` : (`timeElapsed`, `startValue`, `byValue`, `duration`) => `number` -Defined in: [src/util/animation/types.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L34) +Defined in: [src/util/animation/types.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L34) An easing function used to calculate the current value diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TOnAnimationChangeCallback.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TOnAnimationChangeCallback.md index ff26e2ba..fa3c2719 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TOnAnimationChangeCallback.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TOnAnimationChangeCallback.md @@ -7,7 +7,7 @@ title: "TOnAnimationChangeCallback" > **TOnAnimationChangeCallback**\<`T`, `R`\> = (`value`, `valueProgress`, `durationProgress`) => `R` -Defined in: [src/util/animation/types.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L12) +Defined in: [src/util/animation/types.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L12) Callback called every frame diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TProjectStrokeOnPointsOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TProjectStrokeOnPointsOptions.md index 2234467e..26c95a25 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TProjectStrokeOnPointsOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TProjectStrokeOnPointsOptions.md @@ -7,7 +7,7 @@ title: "TProjectStrokeOnPointsOptions" > **TProjectStrokeOnPointsOptions** = `object` -Defined in: [src/util/misc/projectStroke/types.ts:4](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L4) +Defined in: [src/util/misc/projectStroke/types.ts:4](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L4) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:4](https://github.com/fabricjs > **scaleX**: `number` -Defined in: [src/util/misc/projectStroke/types.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L13) +Defined in: [src/util/misc/projectStroke/types.ts:13](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L13) *** @@ -23,7 +23,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:13](https://github.com/fabricj > **scaleY**: `number` -Defined in: [src/util/misc/projectStroke/types.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L14) +Defined in: [src/util/misc/projectStroke/types.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L14) *** @@ -31,7 +31,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:14](https://github.com/fabricj > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/util/misc/projectStroke/types.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L15) +Defined in: [src/util/misc/projectStroke/types.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L15) *** @@ -39,7 +39,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:15](https://github.com/fabricj > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/util/misc/projectStroke/types.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L16) +Defined in: [src/util/misc/projectStroke/types.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L16) *** @@ -47,7 +47,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:16](https://github.com/fabricj > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/util/misc/projectStroke/types.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L6) +Defined in: [src/util/misc/projectStroke/types.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L6) *** @@ -55,7 +55,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:6](https://github.com/fabricjs > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/util/misc/projectStroke/types.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L7) +Defined in: [src/util/misc/projectStroke/types.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L7) *** @@ -63,7 +63,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:7](https://github.com/fabricjs > **strokeMiterLimit**: `number` -Defined in: [src/util/misc/projectStroke/types.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L11) +Defined in: [src/util/misc/projectStroke/types.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L11) https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-miterlimit @@ -73,7 +73,7 @@ https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-miterlimit > **strokeUniform**: `boolean` -Defined in: [src/util/misc/projectStroke/types.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L12) +Defined in: [src/util/misc/projectStroke/types.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L12) *** @@ -81,4 +81,4 @@ Defined in: [src/util/misc/projectStroke/types.ts:12](https://github.com/fabricj > **strokeWidth**: `number` -Defined in: [src/util/misc/projectStroke/types.ts:5](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L5) +Defined in: [src/util/misc/projectStroke/types.ts:5](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L5) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TProjection.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TProjection.md index 6111bd2a..abcc15e3 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TProjection.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TProjection.md @@ -7,7 +7,7 @@ title: "TProjection" > **TProjection** = `object` -Defined in: [src/util/misc/projectStroke/types.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L19) +Defined in: [src/util/misc/projectStroke/types.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L19) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:19](https://github.com/fabricj > `optional` **angle**: [`TRadian`](/api/type-aliases/tradian/) -Defined in: [src/util/misc/projectStroke/types.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L22) +Defined in: [src/util/misc/projectStroke/types.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L22) *** @@ -23,7 +23,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:22](https://github.com/fabricj > `optional` **bisector**: [`Point`](/api/classes/point/) -Defined in: [src/util/misc/projectStroke/types.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L23) +Defined in: [src/util/misc/projectStroke/types.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L23) *** @@ -31,7 +31,7 @@ Defined in: [src/util/misc/projectStroke/types.ts:23](https://github.com/fabricj > **originPoint**: [`Point`](/api/classes/point/) -Defined in: [src/util/misc/projectStroke/types.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L21) +Defined in: [src/util/misc/projectStroke/types.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L21) *** @@ -39,4 +39,4 @@ Defined in: [src/util/misc/projectStroke/types.ts:21](https://github.com/fabricj > **projectedPoint**: [`Point`](/api/classes/point/) -Defined in: [src/util/misc/projectStroke/types.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/projectStroke/types.ts#L20) +Defined in: [src/util/misc/projectStroke/types.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/projectStroke/types.ts#L20) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TQrDecomposeOut.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TQrDecomposeOut.md index f6e1a4d1..3d2d1638 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TQrDecomposeOut.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TQrDecomposeOut.md @@ -7,4 +7,4 @@ title: "TQrDecomposeOut" > **TQrDecomposeOut** = `Required`\<`Omit`\<[`TComposeMatrixArgs`](/api/fabric/namespaces/util/type-aliases/tcomposematrixargs/), `"flipX"` \| `"flipY"`\>\> -Defined in: [src/util/misc/matrix.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L31) +Defined in: [src/util/misc/matrix.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L31) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TRotateMatrixArgs.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TRotateMatrixArgs.md index 8586f205..730058c4 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TRotateMatrixArgs.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TRotateMatrixArgs.md @@ -7,7 +7,7 @@ title: "TRotateMatrixArgs" > **TRotateMatrixArgs** = `object` -Defined in: [src/util/misc/matrix.ts:9](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L9) +Defined in: [src/util/misc/matrix.ts:9](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L9) ## Properties @@ -15,4 +15,4 @@ Defined in: [src/util/misc/matrix.ts:9](https://github.com/fabricjs/fabric.js/bl > `optional` **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/util/misc/matrix.ts:10](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L10) +Defined in: [src/util/misc/matrix.ts:10](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L10) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TScaleMatrixArgs.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TScaleMatrixArgs.md index 3cc6b9c7..9c2d08dd 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TScaleMatrixArgs.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TScaleMatrixArgs.md @@ -7,7 +7,7 @@ title: "TScaleMatrixArgs" > **TScaleMatrixArgs** = `object` -Defined in: [src/util/misc/matrix.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L18) +Defined in: [src/util/misc/matrix.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L18) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/util/misc/matrix.ts:18](https://github.com/fabricjs/fabric.js/b > `optional` **flipX**: `boolean` -Defined in: [src/util/misc/matrix.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L21) +Defined in: [src/util/misc/matrix.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L21) *** @@ -23,7 +23,7 @@ Defined in: [src/util/misc/matrix.ts:21](https://github.com/fabricjs/fabric.js/b > `optional` **flipY**: `boolean` -Defined in: [src/util/misc/matrix.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L22) +Defined in: [src/util/misc/matrix.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L22) *** @@ -31,7 +31,7 @@ Defined in: [src/util/misc/matrix.ts:22](https://github.com/fabricjs/fabric.js/b > `optional` **scaleX**: `number` -Defined in: [src/util/misc/matrix.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L19) +Defined in: [src/util/misc/matrix.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L19) *** @@ -39,7 +39,7 @@ Defined in: [src/util/misc/matrix.ts:19](https://github.com/fabricjs/fabric.js/b > `optional` **scaleY**: `number` -Defined in: [src/util/misc/matrix.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L20) +Defined in: [src/util/misc/matrix.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L20) *** @@ -47,7 +47,7 @@ Defined in: [src/util/misc/matrix.ts:20](https://github.com/fabricjs/fabric.js/b > `optional` **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/util/misc/matrix.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L23) +Defined in: [src/util/misc/matrix.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L23) *** @@ -55,4 +55,4 @@ Defined in: [src/util/misc/matrix.ts:23](https://github.com/fabricjs/fabric.js/b > `optional` **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/util/misc/matrix.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L24) +Defined in: [src/util/misc/matrix.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L24) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TTranslateMatrixArgs.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TTranslateMatrixArgs.md index 89e32023..72fa39f8 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TTranslateMatrixArgs.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TTranslateMatrixArgs.md @@ -7,7 +7,7 @@ title: "TTranslateMatrixArgs" > **TTranslateMatrixArgs** = `object` -Defined in: [src/util/misc/matrix.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L13) +Defined in: [src/util/misc/matrix.ts:13](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L13) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/util/misc/matrix.ts:13](https://github.com/fabricjs/fabric.js/b > `optional` **translateX**: `number` -Defined in: [src/util/misc/matrix.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L14) +Defined in: [src/util/misc/matrix.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L14) *** @@ -23,4 +23,4 @@ Defined in: [src/util/misc/matrix.ts:14](https://github.com/fabricjs/fabric.js/b > `optional` **translateY**: `number` -Defined in: [src/util/misc/matrix.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/matrix.ts#L15) +Defined in: [src/util/misc/matrix.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/matrix.ts#L15) diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/TextStyleArray.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/TextStyleArray.md index 9b3434b0..c93decde 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/TextStyleArray.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/TextStyleArray.md @@ -7,7 +7,7 @@ title: "TextStyleArray" > **TextStyleArray** = `object`[] -Defined in: [src/util/misc/textStyles.ts:9](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/misc/textStyles.ts#L9) +Defined in: [src/util/misc/textStyles.ts:9](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/misc/textStyles.ts#L9) ## Type Declaration diff --git a/src/content/docs/api/fabric/namespaces/util/type-aliases/ValueAnimationOptions.md b/src/content/docs/api/fabric/namespaces/util/type-aliases/ValueAnimationOptions.md index 41673cd3..2c1534f7 100644 --- a/src/content/docs/api/fabric/namespaces/util/type-aliases/ValueAnimationOptions.md +++ b/src/content/docs/api/fabric/namespaces/util/type-aliases/ValueAnimationOptions.md @@ -7,4 +7,4 @@ title: "ValueAnimationOptions" > **ValueAnimationOptions** = [`TAnimationOptions`](/api/fabric/namespaces/util/type-aliases/tanimationoptions/)\<`number`\> -Defined in: [src/util/animation/types.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/types.ts#L121) +Defined in: [src/util/animation/types.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/types.ts#L121) diff --git a/src/content/docs/api/functions/createCollectionMixin.md b/src/content/docs/api/functions/createCollectionMixin.md index 02e58798..ee69d728 100644 --- a/src/content/docs/api/functions/createCollectionMixin.md +++ b/src/content/docs/api/functions/createCollectionMixin.md @@ -7,7 +7,7 @@ title: "createCollectionMixin" > **createCollectionMixin**\<`TBase`\>(`Base`): \{(...`args`): `Collection`; `prototype`: `Collection`\<`any`\>; \} & `TBase` -Defined in: [src/Collection.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Collection.ts#L15) +Defined in: [src/Collection.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Collection.ts#L15) ## Type Parameters diff --git a/src/content/docs/api/functions/getEnv.md b/src/content/docs/api/functions/getEnv.md index d2325b4e..a88e69b3 100644 --- a/src/content/docs/api/functions/getEnv.md +++ b/src/content/docs/api/functions/getEnv.md @@ -7,7 +7,7 @@ title: "getEnv" > **getEnv**(): `TFabricEnv` -Defined in: [src/env/index.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/env/index.ts#L36) +Defined in: [src/env/index.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/env/index.ts#L36) In order to support SSR we **MUST** access the browser env only after the window has loaded diff --git a/src/content/docs/api/functions/getFabricDocument.md b/src/content/docs/api/functions/getFabricDocument.md index 458b363e..b91678a4 100644 --- a/src/content/docs/api/functions/getFabricDocument.md +++ b/src/content/docs/api/functions/getFabricDocument.md @@ -7,7 +7,7 @@ title: "getFabricDocument" > **getFabricDocument**(): `Document` -Defined in: [src/env/index.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/env/index.ts#L38) +Defined in: [src/env/index.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/env/index.ts#L38) ## Returns diff --git a/src/content/docs/api/functions/getFabricWindow.md b/src/content/docs/api/functions/getFabricWindow.md index 1de61172..ecb524bd 100644 --- a/src/content/docs/api/functions/getFabricWindow.md +++ b/src/content/docs/api/functions/getFabricWindow.md @@ -7,7 +7,7 @@ title: "getFabricWindow" > **getFabricWindow**(): `Window` & *typeof* `globalThis` \| `DOMWindow` -Defined in: [src/env/index.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/env/index.ts#L40) +Defined in: [src/env/index.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/env/index.ts#L40) ## Returns diff --git a/src/content/docs/api/functions/getFilterBackend.md b/src/content/docs/api/functions/getFilterBackend.md index d667fa30..a3869093 100644 --- a/src/content/docs/api/functions/getFilterBackend.md +++ b/src/content/docs/api/functions/getFilterBackend.md @@ -7,7 +7,7 @@ title: "getFilterBackend" > **getFilterBackend**(`strict?`): `FilterBackend` -Defined in: [src/filters/FilterBackend.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/FilterBackend.ts#L29) +Defined in: [src/filters/FilterBackend.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/FilterBackend.ts#L29) Get the current fabricJS filter backend or initialize one if not available yet diff --git a/src/content/docs/api/functions/initFilterBackend.md b/src/content/docs/api/functions/initFilterBackend.md index 0dd69cc5..99bbf17d 100644 --- a/src/content/docs/api/functions/initFilterBackend.md +++ b/src/content/docs/api/functions/initFilterBackend.md @@ -7,7 +7,7 @@ title: "initFilterBackend" > **initFilterBackend**(): `FilterBackend` -Defined in: [src/filters/FilterBackend.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/FilterBackend.ts#L14) +Defined in: [src/filters/FilterBackend.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/FilterBackend.ts#L14) Verifies if it is possible to initialize webgl or fallback on a canvas2d filtering backend diff --git a/src/content/docs/api/functions/isPutImageFaster.md b/src/content/docs/api/functions/isPutImageFaster.md index cb06922c..b5823b73 100644 --- a/src/content/docs/api/functions/isPutImageFaster.md +++ b/src/content/docs/api/functions/isPutImageFaster.md @@ -7,7 +7,7 @@ title: "isPutImageFaster" > **isPutImageFaster**(`width`, `height`): `boolean` -Defined in: [src/filters/utils.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/utils.ts#L18) +Defined in: [src/filters/utils.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/utils.ts#L18) Pick a method to copy data from GL context to 2d canvas. In some browsers using drawImage should be faster, but is also bugged for a small combination of old hardware diff --git a/src/content/docs/api/functions/isWebGLPipelineState.md b/src/content/docs/api/functions/isWebGLPipelineState.md index a4d42c61..3bde1128 100644 --- a/src/content/docs/api/functions/isWebGLPipelineState.md +++ b/src/content/docs/api/functions/isWebGLPipelineState.md @@ -7,7 +7,7 @@ title: "isWebGLPipelineState" > **isWebGLPipelineState**(`options`): `options is TWebGLPipelineState` -Defined in: [src/filters/utils.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/utils.ts#L6) +Defined in: [src/filters/utils.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/utils.ts#L6) ## Parameters diff --git a/src/content/docs/api/functions/loadSVGFromString.md b/src/content/docs/api/functions/loadSVGFromString.md index 7cd47dcc..32bd2ad3 100644 --- a/src/content/docs/api/functions/loadSVGFromString.md +++ b/src/content/docs/api/functions/loadSVGFromString.md @@ -7,7 +7,7 @@ title: "loadSVGFromString" > **loadSVGFromString**(`string`, `reviver?`, `options?`): `Promise`\<`SVGParsingOutput`\> -Defined in: [src/parser/loadSVGFromString.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/parser/loadSVGFromString.ts#L19) +Defined in: [src/parser/loadSVGFromString.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/parser/loadSVGFromString.ts#L19) Takes string corresponding to an SVG document, and parses it into a set of fabric objects diff --git a/src/content/docs/api/functions/loadSVGFromURL.md b/src/content/docs/api/functions/loadSVGFromURL.md index 8fb3d9fc..67159732 100644 --- a/src/content/docs/api/functions/loadSVGFromURL.md +++ b/src/content/docs/api/functions/loadSVGFromURL.md @@ -7,7 +7,7 @@ title: "loadSVGFromURL" > **loadSVGFromURL**(`url`, `reviver?`, `options?`): `Promise`\<`SVGParsingOutput`\> -Defined in: [src/parser/loadSVGFromURL.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/parser/loadSVGFromURL.ts#L21) +Defined in: [src/parser/loadSVGFromURL.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/parser/loadSVGFromURL.ts#L21) Takes url corresponding to an SVG document, and parses it into a set of fabric objects. Note that SVG is fetched via fetch API, so it needs to conform to SOP (Same Origin Policy) diff --git a/src/content/docs/api/functions/parseSVGDocument.md b/src/content/docs/api/functions/parseSVGDocument.md index e8fac125..7dd25603 100644 --- a/src/content/docs/api/functions/parseSVGDocument.md +++ b/src/content/docs/api/functions/parseSVGDocument.md @@ -7,7 +7,7 @@ title: "parseSVGDocument" > **parseSVGDocument**(`doc`, `reviver?`, `__namedParameters?`): `Promise`\<`SVGParsingOutput`\> -Defined in: [src/parser/parseSVGDocument.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/parser/parseSVGDocument.ts#L35) +Defined in: [src/parser/parseSVGDocument.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/parser/parseSVGDocument.ts#L35) Parses an SVG document, converts it to an array of corresponding fabric.* instances and passes them to a callback diff --git a/src/content/docs/api/functions/setEnv.md b/src/content/docs/api/functions/setEnv.md index f228294c..8ca4600e 100644 --- a/src/content/docs/api/functions/setEnv.md +++ b/src/content/docs/api/functions/setEnv.md @@ -7,7 +7,7 @@ title: "setEnv" > **setEnv**(`value`): `void` -Defined in: [src/env/index.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/env/index.ts#L29) +Defined in: [src/env/index.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/env/index.ts#L29) Sets the environment variables used by fabric.\ This is exposed for special cases, such as configuring a test environment, and should be used with care. diff --git a/src/content/docs/api/functions/setFilterBackend.md b/src/content/docs/api/functions/setFilterBackend.md index febc327c..ee6a2678 100644 --- a/src/content/docs/api/functions/setFilterBackend.md +++ b/src/content/docs/api/functions/setFilterBackend.md @@ -7,7 +7,7 @@ title: "setFilterBackend" > **setFilterBackend**(`backend`): `void` -Defined in: [src/filters/FilterBackend.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/FilterBackend.ts#L36) +Defined in: [src/filters/FilterBackend.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/FilterBackend.ts#L36) ## Parameters diff --git a/src/content/docs/api/interfaces/ActiveSelectionOptions.md b/src/content/docs/api/interfaces/ActiveSelectionOptions.md index cdeab26d..87f0b6eb 100644 --- a/src/content/docs/api/interfaces/ActiveSelectionOptions.md +++ b/src/content/docs/api/interfaces/ActiveSelectionOptions.md @@ -5,7 +5,7 @@ prev: false title: "ActiveSelectionOptions" --- -Defined in: [src/shapes/ActiveSelection.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L16) +Defined in: [src/shapes/ActiveSelection.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L16) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/ActiveSelection.ts:16](https://github.com/fabricjs/fabri > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -42,7 +42,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -62,7 +62,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -77,7 +77,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -97,7 +97,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -115,7 +115,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -135,7 +135,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -159,7 +159,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -171,7 +171,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -193,7 +193,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -212,7 +212,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -229,7 +229,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -249,7 +249,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -273,7 +273,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -293,7 +293,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -317,7 +317,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -347,7 +347,7 @@ This API is no longer supported and may be removed in a future release. > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -361,7 +361,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -379,7 +379,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -400,7 +400,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -422,7 +422,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -442,7 +442,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -462,7 +462,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -476,7 +476,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -490,7 +490,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -510,7 +510,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -524,7 +524,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -544,7 +544,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -558,7 +558,7 @@ When `false`, default object's values are not included in its serialization > **interactive**: `boolean` -Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L57) +Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L57) #### Inherited from @@ -570,7 +570,7 @@ Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/ > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -592,7 +592,7 @@ false > **layoutManager**: [`LayoutManager`](/api/classes/layoutmanager/) -Defined in: [src/shapes/Group.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L67) +Defined in: [src/shapes/Group.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L67) #### Inherited from @@ -604,7 +604,7 @@ Defined in: [src/shapes/Group.ts:67](https://github.com/fabricjs/fabric.js/blob/ > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -626,7 +626,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -640,7 +640,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -654,7 +654,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -668,7 +668,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -682,7 +682,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -696,7 +696,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -710,7 +710,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -724,7 +724,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -738,7 +738,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -758,7 +758,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -778,7 +778,7 @@ null > **multiSelectionStacking**: [`MultiSelectionStacking`](/api/type-aliases/multiselectionstacking/) -Defined in: [src/shapes/ActiveSelection.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L17) +Defined in: [src/shapes/ActiveSelection.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L17) *** @@ -786,11 +786,11 @@ Defined in: [src/shapes/ActiveSelection.ts:17](https://github.com/fabricjs/fabri > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -810,7 +810,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -836,7 +836,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -856,7 +856,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -883,7 +883,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -910,7 +910,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -930,7 +930,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -944,7 +944,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -958,7 +958,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -978,7 +978,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -998,7 +998,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1013,7 +1013,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1032,7 +1032,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1052,7 +1052,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1072,7 +1072,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1092,7 +1092,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1106,7 +1106,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1121,7 +1121,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1142,7 +1142,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1162,7 +1162,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1182,7 +1182,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1202,7 +1202,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1216,7 +1216,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1236,7 +1236,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1269,7 +1269,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1289,7 +1289,7 @@ Width of a stroke used to render this object > **subTargetCheck**: `boolean` -Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L56) +Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L56) #### Inherited from @@ -1301,7 +1301,7 @@ Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/ > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1323,7 +1323,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1343,7 +1343,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1363,7 +1363,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1377,7 +1377,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/BasicTransformEvent.md b/src/content/docs/api/interfaces/BasicTransformEvent.md index 621ded33..5dbfb911 100644 --- a/src/content/docs/api/interfaces/BasicTransformEvent.md +++ b/src/content/docs/api/interfaces/BasicTransformEvent.md @@ -5,7 +5,7 @@ prev: false title: "BasicTransformEvent" --- -Defined in: [src/EventTypeDefs.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L111) +Defined in: [src/EventTypeDefs.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L111) ## Extends @@ -23,7 +23,7 @@ Defined in: [src/EventTypeDefs.ts:111](https://github.com/fabricjs/fabric.js/blo > **e**: `E` -Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L104) +Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L104) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blo > **pointer**: [`Point`](/api/classes/point/) -Defined in: [src/EventTypeDefs.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L118) +Defined in: [src/EventTypeDefs.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L118) *** @@ -43,4 +43,4 @@ Defined in: [src/EventTypeDefs.ts:118](https://github.com/fabricjs/fabric.js/blo > **transform**: [`Transform`](/api/type-aliases/transform/) -Defined in: [src/EventTypeDefs.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L114) +Defined in: [src/EventTypeDefs.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L114) diff --git a/src/content/docs/api/interfaces/CanvasEvents.md b/src/content/docs/api/interfaces/CanvasEvents.md index 9b75a2a7..4d1292e8 100644 --- a/src/content/docs/api/interfaces/CanvasEvents.md +++ b/src/content/docs/api/interfaces/CanvasEvents.md @@ -5,7 +5,7 @@ prev: false title: "CanvasEvents" --- -Defined in: [src/EventTypeDefs.ts:322](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L322) +Defined in: [src/EventTypeDefs.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L326) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/EventTypeDefs.ts:322](https://github.com/fabricjs/fabric.js/blo > **after:render**: `object` -Defined in: [src/EventTypeDefs.ts:317](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L317) +Defined in: [src/EventTypeDefs.ts:321](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L321) #### ctx @@ -33,7 +33,7 @@ Defined in: [src/EventTypeDefs.ts:317](https://github.com/fabricjs/fabric.js/blo > **before:path:created**: `object` -Defined in: [src/EventTypeDefs.ts:331](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L331) +Defined in: [src/EventTypeDefs.ts:335](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L335) #### path @@ -45,7 +45,7 @@ Defined in: [src/EventTypeDefs.ts:331](https://github.com/fabricjs/fabric.js/blo > **before:render**: `object` -Defined in: [src/EventTypeDefs.ts:316](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L316) +Defined in: [src/EventTypeDefs.ts:320](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L320) #### ctx @@ -61,7 +61,7 @@ Defined in: [src/EventTypeDefs.ts:316](https://github.com/fabricjs/fabric.js/blo > **before:selection:cleared**: `Partial`\<[`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\>\> & `object` -Defined in: [src/EventTypeDefs.ts:231](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L231) +Defined in: [src/EventTypeDefs.ts:235](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L235) #### Type Declaration @@ -79,7 +79,7 @@ Defined in: [src/EventTypeDefs.ts:231](https://github.com/fabricjs/fabric.js/blo > **before:transform**: [`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & `object` -Defined in: [src/EventTypeDefs.ts:154](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L154) +Defined in: [src/EventTypeDefs.ts:154](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L154) #### Type Declaration @@ -97,7 +97,7 @@ Defined in: [src/EventTypeDefs.ts:154](https://github.com/fabricjs/fabric.js/blo > **canvas:cleared**: `never` -Defined in: [src/EventTypeDefs.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L313) +Defined in: [src/EventTypeDefs.ts:317](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L317) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [src/EventTypeDefs.ts:313](https://github.com/fabricjs/fabric.js/blo > **contextmenu**: `SimpleEventHandler`\<`Event`\> -Defined in: [src/EventTypeDefs.ts:290](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L290) +Defined in: [src/EventTypeDefs.ts:294](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L294) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [src/EventTypeDefs.ts:290](https://github.com/fabricjs/fabric.js/blo > **contextmenu:before**: `SimpleEventHandler`\<`Event`\> -Defined in: [src/EventTypeDefs.ts:289](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L289) +Defined in: [src/EventTypeDefs.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L293) #### Inherited from @@ -133,7 +133,7 @@ Defined in: [src/EventTypeDefs.ts:289](https://github.com/fabricjs/fabric.js/blo > **drag**: [`DragEventData`](/api/interfaces/drageventdata/) -Defined in: [src/EventTypeDefs.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L208) +Defined in: [src/EventTypeDefs.ts:212](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L212) #### Inherited from @@ -145,7 +145,7 @@ Defined in: [src/EventTypeDefs.ts:208](https://github.com/fabricjs/fabric.js/blo > **drag:enter**: [`DragEventData`](/api/interfaces/drageventdata/) & `InEvent` -Defined in: [src/EventTypeDefs.ts:219](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L219) +Defined in: [src/EventTypeDefs.ts:223](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L223) #### Inherited from @@ -157,7 +157,7 @@ Defined in: [src/EventTypeDefs.ts:219](https://github.com/fabricjs/fabric.js/blo > **drag:leave**: [`DragEventData`](/api/interfaces/drageventdata/) & `OutEvent` -Defined in: [src/EventTypeDefs.ts:220](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L220) +Defined in: [src/EventTypeDefs.ts:224](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L224) #### Inherited from @@ -169,7 +169,7 @@ Defined in: [src/EventTypeDefs.ts:220](https://github.com/fabricjs/fabric.js/blo > **dragend**: [`DragEventData`](/api/interfaces/drageventdata/) -Defined in: [src/EventTypeDefs.ts:212](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L212) +Defined in: [src/EventTypeDefs.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L216) #### Inherited from @@ -181,7 +181,7 @@ Defined in: [src/EventTypeDefs.ts:212](https://github.com/fabricjs/fabric.js/blo > **dragenter**: [`DragEventData`](/api/interfaces/drageventdata/) & `InEvent` -Defined in: [src/EventTypeDefs.ts:210](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L210) +Defined in: [src/EventTypeDefs.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L214) #### Inherited from @@ -193,7 +193,7 @@ Defined in: [src/EventTypeDefs.ts:210](https://github.com/fabricjs/fabric.js/blo > **dragleave**: [`DragEventData`](/api/interfaces/drageventdata/) & `OutEvent` -Defined in: [src/EventTypeDefs.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L211) +Defined in: [src/EventTypeDefs.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L215) #### Inherited from @@ -205,7 +205,7 @@ Defined in: [src/EventTypeDefs.ts:211](https://github.com/fabricjs/fabric.js/blo > **dragover**: [`DragEventData`](/api/interfaces/drageventdata/) -Defined in: [src/EventTypeDefs.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L209) +Defined in: [src/EventTypeDefs.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L213) #### Inherited from @@ -217,7 +217,7 @@ Defined in: [src/EventTypeDefs.ts:209](https://github.com/fabricjs/fabric.js/blo > **dragstart**: `TEventWithTarget`\<`DragEvent`\> -Defined in: [src/EventTypeDefs.ts:207](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L207) +Defined in: [src/EventTypeDefs.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L211) #### Inherited from @@ -229,7 +229,7 @@ Defined in: [src/EventTypeDefs.ts:207](https://github.com/fabricjs/fabric.js/blo > **drop**: [`DropEventData`](/api/interfaces/dropeventdata/) -Defined in: [src/EventTypeDefs.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L214) +Defined in: [src/EventTypeDefs.ts:218](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L218) #### Inherited from @@ -241,7 +241,7 @@ Defined in: [src/EventTypeDefs.ts:214](https://github.com/fabricjs/fabric.js/blo > **drop:after**: [`DropEventData`](/api/interfaces/dropeventdata/) -Defined in: [src/EventTypeDefs.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L215) +Defined in: [src/EventTypeDefs.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L219) #### Inherited from @@ -253,7 +253,7 @@ Defined in: [src/EventTypeDefs.ts:215](https://github.com/fabricjs/fabric.js/blo > **drop:before**: [`DropEventData`](/api/interfaces/dropeventdata/) -Defined in: [src/EventTypeDefs.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L213) +Defined in: [src/EventTypeDefs.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L217) #### Inherited from @@ -265,7 +265,7 @@ Defined in: [src/EventTypeDefs.ts:213](https://github.com/fabricjs/fabric.js/blo > **erasing:end**: `object` -Defined in: [src/EventTypeDefs.ts:336](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L336) +Defined in: [src/EventTypeDefs.ts:340](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L340) #### drawables @@ -297,7 +297,7 @@ Defined in: [src/EventTypeDefs.ts:336](https://github.com/fabricjs/fabric.js/blo > **erasing:start**: `never` -Defined in: [src/EventTypeDefs.ts:335](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L335) +Defined in: [src/EventTypeDefs.ts:339](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L339) *** @@ -436,7 +436,7 @@ before the cycle of mouse down -> mouse up started > **object:added**: `object` -Defined in: [src/EventTypeDefs.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L240) +Defined in: [src/EventTypeDefs.ts:244](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L244) #### target @@ -452,7 +452,7 @@ Defined in: [src/EventTypeDefs.ts:240](https://github.com/fabricjs/fabric.js/blo > **object:layout:after**: [`LayoutAfterEvent`](/api/type-aliases/layoutafterevent/) & `object` -Defined in: [src/EventTypeDefs.ts:319](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L319) +Defined in: [src/EventTypeDefs.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L323) #### Type Declaration @@ -470,7 +470,7 @@ Defined in: [src/EventTypeDefs.ts:319](https://github.com/fabricjs/fabric.js/blo > **object:layout:before**: [`LayoutBeforeEvent`](/api/type-aliases/layoutbeforeevent/) & `object` -Defined in: [src/EventTypeDefs.ts:318](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L318) +Defined in: [src/EventTypeDefs.ts:322](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L322) #### Type Declaration @@ -488,7 +488,7 @@ Defined in: [src/EventTypeDefs.ts:318](https://github.com/fabricjs/fabric.js/blo > **object:modified**: [`ModifiedEvent`](/api/interfaces/modifiedevent/) -Defined in: [src/EventTypeDefs.ts:164](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L164) +Defined in: [src/EventTypeDefs.ts:164](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L164) #### Inherited from @@ -500,7 +500,7 @@ Defined in: [src/EventTypeDefs.ts:164](https://github.com/fabricjs/fabric.js/blo > **object:modifyPath**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & `object` & [`ModifyPathEvent`](/api/interfaces/modifypathevent/) -Defined in: [src/EventTypeDefs.ts:161](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L161) +Defined in: [src/EventTypeDefs.ts:161](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L161) #### Type Declaration @@ -518,7 +518,7 @@ Defined in: [src/EventTypeDefs.ts:161](https://github.com/fabricjs/fabric.js/blo > **object:modifyPoly**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & `object` -Defined in: [src/EventTypeDefs.ts:160](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L160) +Defined in: [src/EventTypeDefs.ts:160](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L160) #### Type Declaration @@ -536,7 +536,7 @@ Defined in: [src/EventTypeDefs.ts:160](https://github.com/fabricjs/fabric.js/blo > **object:moving**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & `object` -Defined in: [src/EventTypeDefs.ts:155](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L155) +Defined in: [src/EventTypeDefs.ts:155](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L155) #### Type Declaration @@ -554,7 +554,7 @@ Defined in: [src/EventTypeDefs.ts:155](https://github.com/fabricjs/fabric.js/blo > **object:removed**: `object` -Defined in: [src/EventTypeDefs.ts:241](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L241) +Defined in: [src/EventTypeDefs.ts:245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L245) #### target @@ -570,7 +570,7 @@ Defined in: [src/EventTypeDefs.ts:241](https://github.com/fabricjs/fabric.js/blo > **object:resizing**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & `object` -Defined in: [src/EventTypeDefs.ts:159](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L159) +Defined in: [src/EventTypeDefs.ts:159](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L159) #### Type Declaration @@ -588,7 +588,7 @@ Defined in: [src/EventTypeDefs.ts:159](https://github.com/fabricjs/fabric.js/blo > **object:rotating**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & `object` -Defined in: [src/EventTypeDefs.ts:157](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L157) +Defined in: [src/EventTypeDefs.ts:157](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L157) #### Type Declaration @@ -606,7 +606,7 @@ Defined in: [src/EventTypeDefs.ts:157](https://github.com/fabricjs/fabric.js/blo > **object:scaling**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & `object` -Defined in: [src/EventTypeDefs.ts:156](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L156) +Defined in: [src/EventTypeDefs.ts:156](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L156) #### Type Declaration @@ -624,7 +624,7 @@ Defined in: [src/EventTypeDefs.ts:156](https://github.com/fabricjs/fabric.js/blo > **object:skewing**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & `object` -Defined in: [src/EventTypeDefs.ts:158](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L158) +Defined in: [src/EventTypeDefs.ts:158](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L158) #### Type Declaration @@ -642,7 +642,7 @@ Defined in: [src/EventTypeDefs.ts:158](https://github.com/fabricjs/fabric.js/blo > **path:created**: `object` -Defined in: [src/EventTypeDefs.ts:332](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L332) +Defined in: [src/EventTypeDefs.ts:336](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L336) #### path @@ -686,7 +686,7 @@ Defined in: [src/EventTypeDefs.ts:332](https://github.com/fabricjs/fabric.js/blo > **selection:cleared**: `Partial`\<[`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\>\> & `object` -Defined in: [src/EventTypeDefs.ts:234](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L234) +Defined in: [src/EventTypeDefs.ts:238](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L238) #### Type Declaration @@ -704,7 +704,7 @@ Defined in: [src/EventTypeDefs.ts:234](https://github.com/fabricjs/fabric.js/blo > **selection:created**: `Partial`\<[`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\>\> & `object` -Defined in: [src/EventTypeDefs.ts:224](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L224) +Defined in: [src/EventTypeDefs.ts:228](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L228) #### Type Declaration @@ -722,7 +722,7 @@ Defined in: [src/EventTypeDefs.ts:224](https://github.com/fabricjs/fabric.js/blo > **selection:updated**: `Partial`\<[`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\>\> & `object` -Defined in: [src/EventTypeDefs.ts:227](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L227) +Defined in: [src/EventTypeDefs.ts:231](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L231) #### Type Declaration @@ -744,7 +744,7 @@ Defined in: [src/EventTypeDefs.ts:227](https://github.com/fabricjs/fabric.js/blo > **text:changed**: `object` -Defined in: [src/EventTypeDefs.ts:350](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L350) +Defined in: [src/EventTypeDefs.ts:354](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L354) #### target @@ -756,7 +756,7 @@ Defined in: [src/EventTypeDefs.ts:350](https://github.com/fabricjs/fabric.js/blo > **text:editing:entered**: `object` & `Partial`\<[`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\>\> -Defined in: [src/EventTypeDefs.ts:351](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L351) +Defined in: [src/EventTypeDefs.ts:355](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L355) #### Type Declaration @@ -770,7 +770,7 @@ Defined in: [src/EventTypeDefs.ts:351](https://github.com/fabricjs/fabric.js/blo > **text:editing:exited**: `object` -Defined in: [src/EventTypeDefs.ts:352](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L352) +Defined in: [src/EventTypeDefs.ts:356](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L356) #### target @@ -782,7 +782,7 @@ Defined in: [src/EventTypeDefs.ts:352](https://github.com/fabricjs/fabric.js/blo > **text:selection:changed**: `object` -Defined in: [src/EventTypeDefs.ts:349](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L349) +Defined in: [src/EventTypeDefs.ts:353](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L353) #### target diff --git a/src/content/docs/api/interfaces/CanvasOptions.md b/src/content/docs/api/interfaces/CanvasOptions.md index 2a2283c1..cd84fc40 100644 --- a/src/content/docs/api/interfaces/CanvasOptions.md +++ b/src/content/docs/api/interfaces/CanvasOptions.md @@ -5,7 +5,7 @@ prev: false title: "CanvasOptions" --- -Defined in: [src/canvas/CanvasOptions.ts:229](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L229) +Defined in: [src/canvas/CanvasOptions.ts:229](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L229) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/canvas/CanvasOptions.ts:229](https://github.com/fabricjs/fabric > **allowTouchScrolling**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L148) +Defined in: [src/canvas/StaticCanvasOptions.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L148) Indicates whether the browser can be scrolled when using a touchscreen and dragging on the canvas It gives PRIORITY to DOM scrolling, it doesn't make it always possible. @@ -38,7 +38,7 @@ move to Canvas > **altActionKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) -Defined in: [src/canvas/CanvasOptions.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L61) +Defined in: [src/canvas/CanvasOptions.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L61) Indicates which key enable alternate action on corner values: 'altKey', 'shiftKey', 'ctrlKey'. @@ -59,7 +59,7 @@ feature is disabled feature disabled. > **altSelectionKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) -Defined in: [src/canvas/CanvasOptions.ts:95](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L95) +Defined in: [src/canvas/CanvasOptions.ts:95](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L95) Indicates which key enable alternative selection in case of a target overlapping with active object and we don't want to loose the @@ -85,7 +85,7 @@ feature is disabled. > **backgroundColor**: `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/canvas/StaticCanvasOptions.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L18) +Defined in: [src/canvas/StaticCanvasOptions.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L18) Background color of canvas instance. @@ -99,7 +99,7 @@ Background color of canvas instance. > `optional` **backgroundImage**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvasOptions.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L27) +Defined in: [src/canvas/StaticCanvasOptions.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L27) Background image of canvas instance. since 2.4.0 image caching is active, please when putting an image as background, add to the @@ -116,7 +116,7 @@ vale. As an alternative you can disable image objectCaching > **backgroundVpt**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L12) +Defined in: [src/canvas/StaticCanvasOptions.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L12) if set to false background image is not affected by viewport transform @@ -138,7 +138,7 @@ we should really find a different way to do this > **centeredKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) -Defined in: [src/canvas/CanvasOptions.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L51) +Defined in: [src/canvas/CanvasOptions.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L51) Indicates which key enable centered Transform values: 'altKey', 'shiftKey', 'ctrlKey'. @@ -159,7 +159,7 @@ feature is disabled feature disabled. > **centeredRotation**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L41) +Defined in: [src/canvas/CanvasOptions.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L41) When true, objects use center point as the origin of rotate transformation. Backwards incompatibility note: This property replaces "centerTransform" (Boolean). @@ -178,7 +178,7 @@ When true, objects use center point as the origin of rotate transformation. > **centeredScaling**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L33) +Defined in: [src/canvas/CanvasOptions.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L33) When true, objects use center point as the origin of scale transformation. Backwards incompatibility note: This property replaces "centerTransform" (Boolean). @@ -197,7 +197,7 @@ When true, objects use center point as the origin of scale transformation. > `optional` **clipPath**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvasOptions.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L96) +Defined in: [src/canvas/StaticCanvasOptions.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L96) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the canvas has rendered, and the context is placed in the @@ -214,7 +214,7 @@ clipPath will clip away controls, if you do not want this to happen use controls > **containerClass**: `string` -Defined in: [src/canvas/CanvasOptions.ts:242](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L242) +Defined in: [src/canvas/CanvasOptions.ts:242](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L242) Default element class that's given to wrapper (div) element of canvas @@ -228,7 +228,7 @@ customize [CanvasDOMManager](/api/classes/canvasdommanager/) instead or access e > **controlsAboveOverlay**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L137) +Defined in: [src/canvas/StaticCanvasOptions.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L137) Indicates whether object controls (borders/controls) are rendered above overlay image @@ -246,7 +246,7 @@ move to Canvas > **defaultCursor**: `string` -Defined in: [src/canvas/CanvasOptions.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L149) +Defined in: [src/canvas/CanvasOptions.ts:149](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L149) Default cursor value used for the entire canvas @@ -266,7 +266,7 @@ default > **enablePointerEvents**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:226](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L226) +Defined in: [src/canvas/CanvasOptions.ts:226](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L226) When the option is enabled, PointerEvent is used instead of TPointerEvent. @@ -280,7 +280,7 @@ When the option is enabled, PointerEvent is used instead of TPointerEvent. > **enableRetinaScaling**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L81) +Defined in: [src/canvas/StaticCanvasOptions.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L81) When true, canvas is scaled by devicePixelRatio for better rendering on retina screens @@ -294,7 +294,7 @@ When true, canvas is scaled by devicePixelRatio for better rendering on retina s > **fireMiddleClick**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:220](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L220) +Defined in: [src/canvas/CanvasOptions.ts:220](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L220) Indicates if the canvas can fire middle click events The default value changed from false to true in Fabric 7.0 @@ -321,7 +321,7 @@ https://fabricjs.com/docs/upgrading/upgrading-to-fabric-70/ > **fireRightClick**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:210](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L210) +Defined in: [src/canvas/CanvasOptions.ts:210](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L210) Indicates if the canvas can fire right click events The default value changed from false to true in Fabric 7.0 @@ -348,7 +348,7 @@ https://fabricjs.com/docs/upgrading/upgrading-to-fabric-70/ > **freeDrawingCursor**: `string` -Defined in: [src/canvas/CanvasOptions.ts:156](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L156) +Defined in: [src/canvas/CanvasOptions.ts:156](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L156) Cursor value used during free drawing @@ -368,7 +368,7 @@ crosshair > **height**: `number` -Defined in: [src/canvas/StaticCanvasOptions.ts:129](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L129) +Defined in: [src/canvas/StaticCanvasOptions.ts:129](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L129) Height in virtual/logical pixels of the canvas. The canvas can be taller than width if retina scaling is active @@ -383,7 +383,7 @@ The canvas can be taller than width if retina scaling is active > **hoverCursor**: `string` -Defined in: [src/canvas/CanvasOptions.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L135) +Defined in: [src/canvas/CanvasOptions.ts:135](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L135) Default cursor value used when hovering over an object on canvas @@ -403,7 +403,7 @@ move > **imageSmoothingEnabled**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L87) +Defined in: [src/canvas/StaticCanvasOptions.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L87) Indicates whether this canvas will use image smoothing, this is on by default in browsers @@ -417,7 +417,7 @@ Indicates whether this canvas will use image smoothing, this is on by default in > **includeDefaultValues**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L105) +Defined in: [src/canvas/StaticCanvasOptions.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L105) Indicates whether toObject/toDatalessObject should include default values if set to false, takes precedence over the object value. @@ -432,7 +432,7 @@ if set to false, takes precedence over the object value. > **moveCursor**: `string` -Defined in: [src/canvas/CanvasOptions.ts:142](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L142) +Defined in: [src/canvas/CanvasOptions.ts:142](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L142) Default cursor value used when moving an object on canvas @@ -452,7 +452,7 @@ move > **notAllowedCursor**: `string` -Defined in: [src/canvas/CanvasOptions.ts:164](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L164) +Defined in: [src/canvas/CanvasOptions.ts:164](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L164) Cursor value used for disabled elements ( corners with disabled action ) @@ -476,7 +476,7 @@ not-allowed > **overlayColor**: `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/canvas/StaticCanvasOptions.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L42) +Defined in: [src/canvas/StaticCanvasOptions.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L42) Overlay color of canvas instance. @@ -494,7 +494,7 @@ Overlay color of canvas instance. > `optional` **overlayImage**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvasOptions.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L51) +Defined in: [src/canvas/StaticCanvasOptions.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L51) Overlay image of canvas instance. since 2.4.0 image caching is active, please when putting an image as overlay, add to the @@ -511,7 +511,7 @@ vale. As an alternative you can disable image objectCaching > **overlayVpt**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L35) +Defined in: [src/canvas/StaticCanvasOptions.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L35) if set to false overlay image is not affected by viewport transform @@ -533,7 +533,7 @@ we should really find a different way to do this > **perPixelTargetFind**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:172](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L172) +Defined in: [src/canvas/CanvasOptions.ts:172](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L172) When true, object detection happens on per-pixel basis rather than on per-bounding-box @@ -547,7 +547,7 @@ When true, object detection happens on per-pixel basis rather than on per-boundi > **preserveObjectStacking**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:250](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L250) +Defined in: [src/canvas/CanvasOptions.ts:250](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L250) Indicates whether objects should remain in current stack position when selected. When false objects are brought to top and rendered as part of the selection group @@ -564,7 +564,7 @@ true > **renderOnAddRemove**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L64) +Defined in: [src/canvas/StaticCanvasOptions.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L64) Indicates whether [StaticCanvas#add](/api/classes/staticcanvas/#add), [StaticCanvas#insertAt](/api/classes/staticcanvas/#insertat) and StaticCanvas#remove, StaticCanvas#moveTo, [StaticCanvas#clear](/api/classes/staticcanvas/#clear) and many more, should also re-render canvas. @@ -583,7 +583,7 @@ Left default to true to do not break documentation and old app, fiddles. > **selection**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L69) +Defined in: [src/canvas/CanvasOptions.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L69) Indicates whether group selection should be enabled @@ -597,7 +597,7 @@ Indicates whether group selection should be enabled > **selectionBorderColor**: `string` -Defined in: [src/canvas/CanvasOptions.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L114) +Defined in: [src/canvas/CanvasOptions.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L114) Color of the border of selection (usually slightly darker than color of selection itself) @@ -611,7 +611,7 @@ Color of the border of selection (usually slightly darker than color of selectio > **selectionColor**: `string` -Defined in: [src/canvas/CanvasOptions.ts:101](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L101) +Defined in: [src/canvas/CanvasOptions.ts:101](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L101) Color of selection @@ -625,7 +625,7 @@ Color of selection > **selectionDashArray**: `number`[] -Defined in: [src/canvas/CanvasOptions.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L108) +Defined in: [src/canvas/CanvasOptions.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L108) Default dash array pattern If not empty the selection border is dashed @@ -640,7 +640,7 @@ If not empty the selection border is dashed > **selectionFullyContained**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:126](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L126) +Defined in: [src/canvas/CanvasOptions.ts:126](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L126) Select only shapes that are fully contained in the dragged selection rectangle. @@ -654,7 +654,7 @@ Select only shapes that are fully contained in the dragged selection rectangle. > **selectionKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) \| (`"altKey"` \| `"ctrlKey"` \| `"metaKey"` \| `"shiftKey"`)[] -Defined in: [src/canvas/CanvasOptions.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L80) +Defined in: [src/canvas/CanvasOptions.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L80) Indicates which key or keys enable multiple click selection Pass value as a string or array of strings @@ -676,7 +676,7 @@ feature is disabled. > **selectionLineWidth**: `number` -Defined in: [src/canvas/CanvasOptions.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L120) +Defined in: [src/canvas/CanvasOptions.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L120) Width of a line used in object/group selection @@ -690,7 +690,7 @@ Width of a line used in object/group selection > **skipOffscreen**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L75) +Defined in: [src/canvas/StaticCanvasOptions.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L75) Based on vptCoords and object.aCoords, skip rendering of objects that are not included in current viewport. @@ -714,7 +714,7 @@ true > **skipTargetFind**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:188](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L188) +Defined in: [src/canvas/CanvasOptions.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L188) When true, target detection is skipped. Target detection will return always undefined. click selection won't work anymore, events will fire with no targets. @@ -732,7 +732,7 @@ if you deactivate both, you should look into staticCanvas. > **stopContextMenu**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:200](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L200) +Defined in: [src/canvas/CanvasOptions.ts:200](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L200) Indicates if the right click on canvas can output the context menu or not The default value changed from false to true in Fabric 7.0 @@ -759,7 +759,7 @@ https://fabricjs.com/docs/upgrading/upgrading-to-fabric-70/ > **svgViewportTransformation**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L112) +Defined in: [src/canvas/StaticCanvasOptions.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L112) When true, getSvgTransform() will apply the StaticCanvas.viewportTransform to the SVG transformation. When true, a zoomed canvas will then produce zoomed SVG output. @@ -774,7 +774,7 @@ a zoomed canvas will then produce zoomed SVG output. > **targetFindTolerance**: `number` -Defined in: [src/canvas/CanvasOptions.ts:178](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L178) +Defined in: [src/canvas/CanvasOptions.ts:178](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L178) Number of pixels around target pixel to tolerate (consider active) during object detection @@ -788,7 +788,7 @@ Number of pixels around target pixel to tolerate (consider active) during object > **uniformScaling**: `boolean` -Defined in: [src/canvas/CanvasOptions.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L12) +Defined in: [src/canvas/CanvasOptions.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L12) When true, objects can be transformed by one side (unproportionately) when dragged on the corners that normally would not do that. @@ -807,7 +807,7 @@ fabric 4.0 // changed name and default value > **uniScaleKey**: [`TOptionalModifierKey`](/api/type-aliases/toptionalmodifierkey/) -Defined in: [src/canvas/CanvasOptions.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/CanvasOptions.ts#L25) +Defined in: [src/canvas/CanvasOptions.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/CanvasOptions.ts#L25) Indicates which key switches uniform scaling. values: 'altKey', 'shiftKey', 'ctrlKey'. @@ -831,7 +831,7 @@ and viceversa. > **viewportTransform**: [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/canvas/StaticCanvasOptions.ts:158](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L158) +Defined in: [src/canvas/StaticCanvasOptions.ts:158](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L158) The transformation (a Canvas 2D API transform matrix) which focuses the viewport @@ -855,7 +855,7 @@ canvas.viewportTransform = [0.7, 0, 0, 0.7, 50, 50]; > **width**: `number` -Defined in: [src/canvas/StaticCanvasOptions.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L122) +Defined in: [src/canvas/StaticCanvasOptions.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L122) Width in virtual/logical pixels of the canvas. The canvas can be larger than width if retina scaling is active diff --git a/src/content/docs/api/interfaces/CircleProps.md b/src/content/docs/api/interfaces/CircleProps.md index 5ddf1b5e..c0dc2c35 100644 --- a/src/content/docs/api/interfaces/CircleProps.md +++ b/src/content/docs/api/interfaces/CircleProps.md @@ -5,7 +5,7 @@ prev: false title: "CircleProps" --- -Defined in: [src/shapes/Circle.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L49) +Defined in: [src/shapes/Circle.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L49) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Circle.ts:49](https://github.com/fabricjs/fabric.js/blob > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -42,7 +42,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -62,7 +62,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -77,7 +77,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -97,7 +97,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -115,7 +115,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -135,7 +135,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -159,7 +159,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -171,7 +171,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -193,7 +193,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -212,7 +212,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -229,7 +229,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -249,7 +249,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -273,7 +273,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -293,7 +293,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -317,7 +317,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -347,7 +347,7 @@ This API is no longer supported and may be removed in a future release. > **counterClockwise**: `boolean` -Defined in: [src/shapes/Circle.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L43) +Defined in: [src/shapes/Circle.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L43) Orientation for the direction of the circle. Setting to true will switch the arc of the circle to traverse from startAngle to endAngle in a counter-clockwise direction. @@ -369,7 +369,7 @@ false > **endAngle**: `number` -Defined in: [src/shapes/Circle.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L35) +Defined in: [src/shapes/Circle.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L35) Angle for the end of the circle, in degrees @@ -389,7 +389,7 @@ Angle for the end of the circle, in degrees > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -403,7 +403,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -421,7 +421,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -442,7 +442,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -464,7 +464,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -484,7 +484,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -504,7 +504,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -518,7 +518,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -532,7 +532,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -552,7 +552,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -566,7 +566,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -586,7 +586,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -600,7 +600,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -622,7 +622,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -644,7 +644,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -658,7 +658,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -672,7 +672,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -686,7 +686,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -700,7 +700,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -714,7 +714,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -728,7 +728,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -742,7 +742,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -756,7 +756,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -776,7 +776,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -796,11 +796,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -820,7 +820,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -846,7 +846,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -866,7 +866,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -893,7 +893,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -920,7 +920,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -940,7 +940,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -954,7 +954,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -968,7 +968,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **radius**: `number` -Defined in: [src/shapes/Circle.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L21) +Defined in: [src/shapes/Circle.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L21) Radius of this circle @@ -988,7 +988,7 @@ Radius of this circle > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -1008,7 +1008,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -1028,7 +1028,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1043,7 +1043,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1062,7 +1062,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1082,7 +1082,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1102,7 +1102,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1122,7 +1122,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1136,7 +1136,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1151,7 +1151,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **startAngle**: `number` -Defined in: [src/shapes/Circle.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L28) +Defined in: [src/shapes/Circle.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L28) Angle for the start of the circle, in degrees. @@ -1171,7 +1171,7 @@ Angle for the start of the circle, in degrees. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1192,7 +1192,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1212,7 +1212,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1232,7 +1232,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1252,7 +1252,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1266,7 +1266,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1286,7 +1286,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1319,7 +1319,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1339,7 +1339,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1361,7 +1361,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1381,7 +1381,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1401,7 +1401,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1415,7 +1415,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/CollectionEvents.md b/src/content/docs/api/interfaces/CollectionEvents.md index 14bd190e..7f439020 100644 --- a/src/content/docs/api/interfaces/CollectionEvents.md +++ b/src/content/docs/api/interfaces/CollectionEvents.md @@ -5,7 +5,7 @@ prev: false title: "CollectionEvents" --- -Defined in: [src/EventTypeDefs.ts:239](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L239) +Defined in: [src/EventTypeDefs.ts:243](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L243) ## Extended by @@ -18,7 +18,7 @@ Defined in: [src/EventTypeDefs.ts:239](https://github.com/fabricjs/fabric.js/blo > **object:added**: `object` -Defined in: [src/EventTypeDefs.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L240) +Defined in: [src/EventTypeDefs.ts:244](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L244) #### target @@ -30,7 +30,7 @@ Defined in: [src/EventTypeDefs.ts:240](https://github.com/fabricjs/fabric.js/blo > **object:removed**: `object` -Defined in: [src/EventTypeDefs.ts:241](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L241) +Defined in: [src/EventTypeDefs.ts:245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L245) #### target diff --git a/src/content/docs/api/interfaces/DragEventData.md b/src/content/docs/api/interfaces/DragEventData.md index 251b83ea..462b7ff8 100644 --- a/src/content/docs/api/interfaces/DragEventData.md +++ b/src/content/docs/api/interfaces/DragEventData.md @@ -5,7 +5,7 @@ prev: false title: "DragEventData" --- -Defined in: [src/EventTypeDefs.ts:192](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L192) +Defined in: [src/EventTypeDefs.ts:196](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L196) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/EventTypeDefs.ts:192](https://github.com/fabricjs/fabric.js/blo > `optional` **canDrop**: `boolean` -Defined in: [src/EventTypeDefs.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L196) +Defined in: [src/EventTypeDefs.ts:200](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L200) *** @@ -29,7 +29,7 @@ Defined in: [src/EventTypeDefs.ts:196](https://github.com/fabricjs/fabric.js/blo > `optional` **didDrop**: `boolean` -Defined in: [src/EventTypeDefs.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L197) +Defined in: [src/EventTypeDefs.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L201) *** @@ -37,7 +37,7 @@ Defined in: [src/EventTypeDefs.ts:197](https://github.com/fabricjs/fabric.js/blo > `optional` **dragSource**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/EventTypeDefs.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L195) +Defined in: [src/EventTypeDefs.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L199) *** @@ -45,7 +45,7 @@ Defined in: [src/EventTypeDefs.ts:195](https://github.com/fabricjs/fabric.js/blo > `optional` **dropTarget**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/EventTypeDefs.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L198) +Defined in: [src/EventTypeDefs.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L202) *** @@ -53,7 +53,7 @@ Defined in: [src/EventTypeDefs.ts:198](https://github.com/fabricjs/fabric.js/blo > **e**: `DragEvent` -Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L104) +Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L104) #### Inherited from @@ -65,7 +65,7 @@ Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blo > `optional` **subTargets**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/EventTypeDefs.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L194) +Defined in: [src/EventTypeDefs.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L198) *** @@ -73,4 +73,4 @@ Defined in: [src/EventTypeDefs.ts:194](https://github.com/fabricjs/fabric.js/blo > `optional` **target**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/EventTypeDefs.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L193) +Defined in: [src/EventTypeDefs.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L197) diff --git a/src/content/docs/api/interfaces/DropEventData.md b/src/content/docs/api/interfaces/DropEventData.md index caf17366..e200f362 100644 --- a/src/content/docs/api/interfaces/DropEventData.md +++ b/src/content/docs/api/interfaces/DropEventData.md @@ -5,7 +5,7 @@ prev: false title: "DropEventData" --- -Defined in: [src/EventTypeDefs.ts:201](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L201) +Defined in: [src/EventTypeDefs.ts:205](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L205) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/EventTypeDefs.ts:201](https://github.com/fabricjs/fabric.js/blo > `optional` **canDrop**: `boolean` -Defined in: [src/EventTypeDefs.ts:196](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L196) +Defined in: [src/EventTypeDefs.ts:200](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L200) #### Inherited from @@ -29,7 +29,7 @@ Defined in: [src/EventTypeDefs.ts:196](https://github.com/fabricjs/fabric.js/blo > `optional` **didDrop**: `boolean` -Defined in: [src/EventTypeDefs.ts:197](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L197) +Defined in: [src/EventTypeDefs.ts:201](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L201) #### Inherited from @@ -41,7 +41,7 @@ Defined in: [src/EventTypeDefs.ts:197](https://github.com/fabricjs/fabric.js/blo > `optional` **dragSource**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/EventTypeDefs.ts:195](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L195) +Defined in: [src/EventTypeDefs.ts:199](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L199) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [src/EventTypeDefs.ts:195](https://github.com/fabricjs/fabric.js/blo > `optional` **dropTarget**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/EventTypeDefs.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L198) +Defined in: [src/EventTypeDefs.ts:202](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L202) #### Inherited from @@ -65,7 +65,7 @@ Defined in: [src/EventTypeDefs.ts:198](https://github.com/fabricjs/fabric.js/blo > **e**: `DragEvent` -Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L104) +Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L104) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blo > **scenePoint**: [`Point`](/api/classes/point/) -Defined in: [src/EventTypeDefs.ts:202](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L202) +Defined in: [src/EventTypeDefs.ts:206](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L206) *** @@ -85,7 +85,7 @@ Defined in: [src/EventTypeDefs.ts:202](https://github.com/fabricjs/fabric.js/blo > `optional` **subTargets**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/EventTypeDefs.ts:194](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L194) +Defined in: [src/EventTypeDefs.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L198) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [src/EventTypeDefs.ts:194](https://github.com/fabricjs/fabric.js/blo > `optional` **target**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/EventTypeDefs.ts:193](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L193) +Defined in: [src/EventTypeDefs.ts:197](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L197) #### Inherited from @@ -109,4 +109,4 @@ Defined in: [src/EventTypeDefs.ts:193](https://github.com/fabricjs/fabric.js/blo > **viewportPoint**: [`Point`](/api/classes/point/) -Defined in: [src/EventTypeDefs.ts:203](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L203) +Defined in: [src/EventTypeDefs.ts:207](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L207) diff --git a/src/content/docs/api/interfaces/EllipseProps.md b/src/content/docs/api/interfaces/EllipseProps.md index 4b4fe596..9ecb5f9b 100644 --- a/src/content/docs/api/interfaces/EllipseProps.md +++ b/src/content/docs/api/interfaces/EllipseProps.md @@ -5,7 +5,7 @@ prev: false title: "EllipseProps" --- -Defined in: [src/shapes/Ellipse.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L25) +Defined in: [src/shapes/Ellipse.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L25) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Ellipse.ts:25](https://github.com/fabricjs/fabric.js/blo > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -42,7 +42,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -62,7 +62,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -77,7 +77,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -97,7 +97,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -115,7 +115,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -135,7 +135,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -159,7 +159,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -171,7 +171,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -193,7 +193,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -212,7 +212,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -229,7 +229,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -249,7 +249,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -273,7 +273,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -293,7 +293,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -317,7 +317,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -347,7 +347,7 @@ This API is no longer supported and may be removed in a future release. > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -361,7 +361,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -379,7 +379,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -400,7 +400,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -422,7 +422,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -442,7 +442,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -462,7 +462,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -476,7 +476,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -490,7 +490,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -510,7 +510,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -524,7 +524,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -544,7 +544,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -558,7 +558,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -580,7 +580,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -602,7 +602,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -616,7 +616,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -630,7 +630,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -644,7 +644,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -658,7 +658,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -672,7 +672,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -686,7 +686,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -700,7 +700,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -714,7 +714,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -734,7 +734,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -754,11 +754,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -778,7 +778,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -804,7 +804,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -824,7 +824,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -851,7 +851,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -878,7 +878,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -898,7 +898,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -912,7 +912,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -926,7 +926,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **rx**: `number` -Defined in: [src/shapes/Ellipse.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L18) +Defined in: [src/shapes/Ellipse.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L18) #### Inherited from @@ -938,7 +938,7 @@ Defined in: [src/shapes/Ellipse.ts:18](https://github.com/fabricjs/fabric.js/blo > **ry**: `number` -Defined in: [src/shapes/Ellipse.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L19) +Defined in: [src/shapes/Ellipse.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L19) #### Inherited from @@ -950,7 +950,7 @@ Defined in: [src/shapes/Ellipse.ts:19](https://github.com/fabricjs/fabric.js/blo > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -970,7 +970,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -990,7 +990,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1005,7 +1005,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1024,7 +1024,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1044,7 +1044,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1064,7 +1064,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1084,7 +1084,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1098,7 +1098,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1113,7 +1113,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1134,7 +1134,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1154,7 +1154,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1174,7 +1174,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1194,7 +1194,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1208,7 +1208,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1228,7 +1228,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1261,7 +1261,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1281,7 +1281,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1303,7 +1303,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1323,7 +1323,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1343,7 +1343,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1357,7 +1357,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/FabricObjectProps.md b/src/content/docs/api/interfaces/FabricObjectProps.md index cab9941d..38cae68a 100644 --- a/src/content/docs/api/interfaces/FabricObjectProps.md +++ b/src/content/docs/api/interfaces/FabricObjectProps.md @@ -5,7 +5,7 @@ prev: false title: "FabricObjectProps" --- -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L6) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L6) ## Extends @@ -27,7 +27,7 @@ Defined in: [src/shapes/Object/types/FabricObjectProps.ts:6](https://github.com/ > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -52,7 +52,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -72,7 +72,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -87,7 +87,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -107,7 +107,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -125,7 +125,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -145,7 +145,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -169,7 +169,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -181,7 +181,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -203,7 +203,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -222,7 +222,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -239,7 +239,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -259,7 +259,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -283,7 +283,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -303,7 +303,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -327,7 +327,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -357,7 +357,7 @@ This API is no longer supported and may be removed in a future release. > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -367,7 +367,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -385,7 +385,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -406,7 +406,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -428,7 +428,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -448,7 +448,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -468,7 +468,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -482,7 +482,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -496,7 +496,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -516,7 +516,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -530,7 +530,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -546,7 +546,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -560,7 +560,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -582,7 +582,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -604,7 +604,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -618,7 +618,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -632,7 +632,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -646,7 +646,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -660,7 +660,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -674,7 +674,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -688,7 +688,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -702,7 +702,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -716,7 +716,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -736,7 +736,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -752,11 +752,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -772,7 +772,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -798,7 +798,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -818,7 +818,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -845,7 +845,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -872,7 +872,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -892,7 +892,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -906,7 +906,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -916,7 +916,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -936,7 +936,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -956,7 +956,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -967,7 +967,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -982,7 +982,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1002,7 +1002,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1022,7 +1022,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1042,7 +1042,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1056,7 +1056,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1071,7 +1071,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1092,7 +1092,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1112,7 +1112,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1132,7 +1132,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1152,7 +1152,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1166,7 +1166,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1186,7 +1186,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1219,7 +1219,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1239,7 +1239,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1261,7 +1261,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1281,7 +1281,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1301,7 +1301,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1315,7 +1315,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/GroupEvents.md b/src/content/docs/api/interfaces/GroupEvents.md index 2e7d47e6..dbc7dc3e 100644 --- a/src/content/docs/api/interfaces/GroupEvents.md +++ b/src/content/docs/api/interfaces/GroupEvents.md @@ -5,7 +5,7 @@ prev: false title: "GroupEvents" --- -Defined in: [src/shapes/Group.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L50) +Defined in: [src/shapes/Group.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L50) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Group.ts:50](https://github.com/fabricjs/fabric.js/blob/ > **added**: `object` -Defined in: [src/EventTypeDefs.ts:303](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L303) +Defined in: [src/EventTypeDefs.ts:307](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L307) #### target @@ -33,7 +33,7 @@ Defined in: [src/EventTypeDefs.ts:303](https://github.com/fabricjs/fabric.js/blo > **before:render**: `object` -Defined in: [src/EventTypeDefs.ts:308](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L308) +Defined in: [src/EventTypeDefs.ts:312](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L312) #### ctx @@ -49,7 +49,7 @@ Defined in: [src/EventTypeDefs.ts:308](https://github.com/fabricjs/fabric.js/blo > **contextmenu**: `SimpleEventHandler`\<`Event`\> -Defined in: [src/EventTypeDefs.ts:290](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L290) +Defined in: [src/EventTypeDefs.ts:294](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L294) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [src/EventTypeDefs.ts:290](https://github.com/fabricjs/fabric.js/blo > **contextmenu:before**: `SimpleEventHandler`\<`Event`\> -Defined in: [src/EventTypeDefs.ts:289](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L289) +Defined in: [src/EventTypeDefs.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L293) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [src/EventTypeDefs.ts:289](https://github.com/fabricjs/fabric.js/blo > **deselected**: `Partial`\<[`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\>\> & `object` -Defined in: [src/EventTypeDefs.ts:299](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L299) +Defined in: [src/EventTypeDefs.ts:303](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L303) #### Type Declaration @@ -91,7 +91,7 @@ Defined in: [src/EventTypeDefs.ts:299](https://github.com/fabricjs/fabric.js/blo > **drag**: [`DragEventData`](/api/interfaces/drageventdata/) -Defined in: [src/EventTypeDefs.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L208) +Defined in: [src/EventTypeDefs.ts:212](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L212) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [src/EventTypeDefs.ts:208](https://github.com/fabricjs/fabric.js/blo > **dragend**: [`DragEventData`](/api/interfaces/drageventdata/) -Defined in: [src/EventTypeDefs.ts:212](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L212) +Defined in: [src/EventTypeDefs.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L216) #### Inherited from @@ -115,7 +115,7 @@ Defined in: [src/EventTypeDefs.ts:212](https://github.com/fabricjs/fabric.js/blo > **dragenter**: [`DragEventData`](/api/interfaces/drageventdata/) & `InEvent` -Defined in: [src/EventTypeDefs.ts:210](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L210) +Defined in: [src/EventTypeDefs.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L214) #### Inherited from @@ -127,7 +127,7 @@ Defined in: [src/EventTypeDefs.ts:210](https://github.com/fabricjs/fabric.js/blo > **dragleave**: [`DragEventData`](/api/interfaces/drageventdata/) & `OutEvent` -Defined in: [src/EventTypeDefs.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L211) +Defined in: [src/EventTypeDefs.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L215) #### Inherited from @@ -139,7 +139,7 @@ Defined in: [src/EventTypeDefs.ts:211](https://github.com/fabricjs/fabric.js/blo > **dragover**: [`DragEventData`](/api/interfaces/drageventdata/) -Defined in: [src/EventTypeDefs.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L209) +Defined in: [src/EventTypeDefs.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L213) #### Inherited from @@ -151,7 +151,7 @@ Defined in: [src/EventTypeDefs.ts:209](https://github.com/fabricjs/fabric.js/blo > **dragstart**: `TEventWithTarget`\<`DragEvent`\> -Defined in: [src/EventTypeDefs.ts:207](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L207) +Defined in: [src/EventTypeDefs.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L211) #### Inherited from @@ -163,7 +163,7 @@ Defined in: [src/EventTypeDefs.ts:207](https://github.com/fabricjs/fabric.js/blo > **drop**: [`DropEventData`](/api/interfaces/dropeventdata/) -Defined in: [src/EventTypeDefs.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L214) +Defined in: [src/EventTypeDefs.ts:218](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L218) #### Inherited from @@ -175,7 +175,7 @@ Defined in: [src/EventTypeDefs.ts:214](https://github.com/fabricjs/fabric.js/blo > **drop:after**: [`DropEventData`](/api/interfaces/dropeventdata/) -Defined in: [src/EventTypeDefs.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L215) +Defined in: [src/EventTypeDefs.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L219) #### Inherited from @@ -187,7 +187,7 @@ Defined in: [src/EventTypeDefs.ts:215](https://github.com/fabricjs/fabric.js/blo > **drop:before**: [`DropEventData`](/api/interfaces/dropeventdata/) -Defined in: [src/EventTypeDefs.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L213) +Defined in: [src/EventTypeDefs.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L217) #### Inherited from @@ -199,7 +199,7 @@ Defined in: [src/EventTypeDefs.ts:213](https://github.com/fabricjs/fabric.js/blo > **erasing:end**: `object` -Defined in: [src/EventTypeDefs.ts:307](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L307) +Defined in: [src/EventTypeDefs.ts:311](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L311) #### path @@ -215,7 +215,7 @@ Defined in: [src/EventTypeDefs.ts:307](https://github.com/fabricjs/fabric.js/blo > **layout:after**: [`LayoutAfterEvent`](/api/type-aliases/layoutafterevent/) -Defined in: [src/shapes/Group.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L52) +Defined in: [src/shapes/Group.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L52) *** @@ -223,7 +223,7 @@ Defined in: [src/shapes/Group.ts:52](https://github.com/fabricjs/fabric.js/blob/ > **layout:before**: [`LayoutBeforeEvent`](/api/type-aliases/layoutbeforeevent/) -Defined in: [src/shapes/Group.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L51) +Defined in: [src/shapes/Group.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L51) *** @@ -231,7 +231,7 @@ Defined in: [src/shapes/Group.ts:51](https://github.com/fabricjs/fabric.js/blob/ > **modified**: [`ModifiedEvent`](/api/interfaces/modifiedevent/) -Defined in: [src/EventTypeDefs.ts:150](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L150) +Defined in: [src/EventTypeDefs.ts:150](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L150) #### Inherited from @@ -243,7 +243,7 @@ Defined in: [src/EventTypeDefs.ts:150](https://github.com/fabricjs/fabric.js/blo > **modifyPath**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & [`ModifyPathEvent`](/api/interfaces/modifypathevent/) -Defined in: [src/EventTypeDefs.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L149) +Defined in: [src/EventTypeDefs.ts:149](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L149) #### Inherited from @@ -255,7 +255,7 @@ Defined in: [src/EventTypeDefs.ts:149](https://github.com/fabricjs/fabric.js/blo > **modifyPoly**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L148) +Defined in: [src/EventTypeDefs.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L148) #### Inherited from @@ -398,7 +398,7 @@ before the cycle of mouse down -> mouse up started > **moving**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:143](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L143) +Defined in: [src/EventTypeDefs.ts:143](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L143) #### Inherited from @@ -410,7 +410,7 @@ Defined in: [src/EventTypeDefs.ts:143](https://github.com/fabricjs/fabric.js/blo > **object:added**: `object` -Defined in: [src/EventTypeDefs.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L240) +Defined in: [src/EventTypeDefs.ts:244](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L244) #### target @@ -426,7 +426,7 @@ Defined in: [src/EventTypeDefs.ts:240](https://github.com/fabricjs/fabric.js/blo > **object:removed**: `object` -Defined in: [src/EventTypeDefs.ts:241](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L241) +Defined in: [src/EventTypeDefs.ts:245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L245) #### target @@ -458,7 +458,7 @@ Defined in: [src/EventTypeDefs.ts:241](https://github.com/fabricjs/fabric.js/blo > **removed**: `object` -Defined in: [src/EventTypeDefs.ts:304](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L304) +Defined in: [src/EventTypeDefs.ts:308](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L308) #### target @@ -474,7 +474,7 @@ Defined in: [src/EventTypeDefs.ts:304](https://github.com/fabricjs/fabric.js/blo > **resizing**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:147](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L147) +Defined in: [src/EventTypeDefs.ts:147](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L147) #### Inherited from @@ -502,7 +502,7 @@ Defined in: [src/EventTypeDefs.ts:147](https://github.com/fabricjs/fabric.js/blo > **rotating**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:145](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L145) +Defined in: [src/EventTypeDefs.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L145) #### Inherited from @@ -514,7 +514,7 @@ Defined in: [src/EventTypeDefs.ts:145](https://github.com/fabricjs/fabric.js/blo > **scaling**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:144](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L144) +Defined in: [src/EventTypeDefs.ts:144](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L144) #### Inherited from @@ -526,7 +526,7 @@ Defined in: [src/EventTypeDefs.ts:144](https://github.com/fabricjs/fabric.js/blo > **selected**: `Partial`\<[`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\>\> & `object` -Defined in: [src/EventTypeDefs.ts:296](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L296) +Defined in: [src/EventTypeDefs.ts:300](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L300) #### Type Declaration @@ -544,7 +544,7 @@ Defined in: [src/EventTypeDefs.ts:296](https://github.com/fabricjs/fabric.js/blo > **skewing**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L146) +Defined in: [src/EventTypeDefs.ts:146](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L146) #### Inherited from diff --git a/src/content/docs/api/interfaces/GroupOwnProps.md b/src/content/docs/api/interfaces/GroupOwnProps.md index 25c2cc65..56e23269 100644 --- a/src/content/docs/api/interfaces/GroupOwnProps.md +++ b/src/content/docs/api/interfaces/GroupOwnProps.md @@ -5,7 +5,7 @@ prev: false title: "GroupOwnProps" --- -Defined in: [src/shapes/Group.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L55) +Defined in: [src/shapes/Group.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L55) ## Extended by @@ -18,7 +18,7 @@ Defined in: [src/shapes/Group.ts:55](https://github.com/fabricjs/fabric.js/blob/ > **interactive**: `boolean` -Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L57) +Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L57) *** @@ -26,4 +26,4 @@ Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/ > **subTargetCheck**: `boolean` -Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L56) +Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L56) diff --git a/src/content/docs/api/interfaces/GroupProps.md b/src/content/docs/api/interfaces/GroupProps.md index ece14fa6..52ad34f0 100644 --- a/src/content/docs/api/interfaces/GroupProps.md +++ b/src/content/docs/api/interfaces/GroupProps.md @@ -5,7 +5,7 @@ prev: false title: "GroupProps" --- -Defined in: [src/shapes/Group.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L66) +Defined in: [src/shapes/Group.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L66) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/shapes/Group.ts:66](https://github.com/fabricjs/fabric.js/blob/ > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -46,7 +46,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -66,7 +66,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -81,7 +81,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -101,7 +101,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -119,7 +119,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -139,7 +139,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -163,7 +163,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -175,7 +175,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -197,7 +197,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -216,7 +216,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -233,7 +233,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -253,7 +253,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -277,7 +277,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -297,7 +297,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -321,7 +321,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -351,7 +351,7 @@ This API is no longer supported and may be removed in a future release. > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -365,7 +365,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -383,7 +383,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -404,7 +404,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -426,7 +426,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -446,7 +446,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -466,7 +466,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -480,7 +480,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -494,7 +494,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -514,7 +514,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -528,7 +528,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -548,7 +548,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -562,7 +562,7 @@ When `false`, default object's values are not included in its serialization > **interactive**: `boolean` -Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L57) +Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L57) #### Inherited from @@ -574,7 +574,7 @@ Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/ > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -596,7 +596,7 @@ false > **layoutManager**: [`LayoutManager`](/api/classes/layoutmanager/) -Defined in: [src/shapes/Group.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L67) +Defined in: [src/shapes/Group.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L67) *** @@ -604,7 +604,7 @@ Defined in: [src/shapes/Group.ts:67](https://github.com/fabricjs/fabric.js/blob/ > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -626,7 +626,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -640,7 +640,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -654,7 +654,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -668,7 +668,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -682,7 +682,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -696,7 +696,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -710,7 +710,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -724,7 +724,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -738,7 +738,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -758,7 +758,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -778,11 +778,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -802,7 +802,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -828,7 +828,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -848,7 +848,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -875,7 +875,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -902,7 +902,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -922,7 +922,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -936,7 +936,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -950,7 +950,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -970,7 +970,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -990,7 +990,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1005,7 +1005,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1024,7 +1024,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1044,7 +1044,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1064,7 +1064,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1084,7 +1084,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1098,7 +1098,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1113,7 +1113,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1134,7 +1134,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1154,7 +1154,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1174,7 +1174,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1194,7 +1194,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1208,7 +1208,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1228,7 +1228,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1261,7 +1261,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1281,7 +1281,7 @@ Width of a stroke used to render this object > **subTargetCheck**: `boolean` -Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L56) +Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L56) #### Inherited from @@ -1293,7 +1293,7 @@ Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/ > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1315,7 +1315,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1335,7 +1335,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1355,7 +1355,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1369,7 +1369,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/ITextProps.md b/src/content/docs/api/interfaces/ITextProps.md index 73a4dc0d..dd4bb68e 100644 --- a/src/content/docs/api/interfaces/ITextProps.md +++ b/src/content/docs/api/interfaces/ITextProps.md @@ -5,7 +5,7 @@ prev: false title: "ITextProps" --- -Defined in: [src/shapes/IText/IText.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L77) +Defined in: [src/shapes/IText/IText.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L77) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/shapes/IText/IText.ts:77](https://github.com/fabricjs/fabric.js > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -46,7 +46,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -66,7 +66,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -81,7 +81,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -101,7 +101,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -119,7 +119,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -139,7 +139,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -163,7 +163,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -175,7 +175,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -197,7 +197,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -216,7 +216,7 @@ when being scaled via the controls. > **charSpacing**: `number` -Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L110) +Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L111) #### Inherited from @@ -228,7 +228,7 @@ Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/ > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -245,7 +245,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -265,7 +265,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -289,7 +289,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -309,7 +309,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -333,7 +333,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -363,7 +363,7 @@ This API is no longer supported and may be removed in a future release. > **direction**: `CanvasDirection` -Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L122) +Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L123) #### Inherited from @@ -375,7 +375,7 @@ Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/ > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -389,7 +389,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -407,7 +407,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -428,7 +428,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -450,7 +450,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -470,7 +470,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -490,7 +490,7 @@ false > **fontFamily**: `string` -Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L114) +Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L115) #### Inherited from @@ -502,7 +502,7 @@ Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/ > **fontSize**: `number` -Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L112) +Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L113) #### Inherited from @@ -514,7 +514,7 @@ Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/ > **fontStyle**: `FontStyle` -Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L115) +Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L116) #### Inherited from @@ -526,7 +526,7 @@ Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/ > **fontWeight**: `string` \| `number` -Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L113) +Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L114) #### Inherited from @@ -538,7 +538,7 @@ Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/ > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -552,7 +552,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -566,7 +566,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -586,7 +586,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -600,7 +600,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -620,7 +620,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -634,7 +634,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -656,7 +656,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -678,7 +678,7 @@ You can change this by setting originX > **lineHeight**: `number` -Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L111) +Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L112) #### Inherited from @@ -690,7 +690,7 @@ Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/ > **linethrough**: `boolean` -Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L120) +Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L121) #### Inherited from @@ -702,7 +702,7 @@ Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/ > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -716,7 +716,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -730,7 +730,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -744,7 +744,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -758,7 +758,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -772,7 +772,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -786,7 +786,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -800,7 +800,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -814,7 +814,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -834,7 +834,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -854,11 +854,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -878,7 +878,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -904,7 +904,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -924,7 +924,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -951,7 +951,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -978,7 +978,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **overline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L119) +Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L120) #### Inherited from @@ -990,7 +990,7 @@ Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/ > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -1010,7 +1010,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1024,7 +1024,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **path**: [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L123) +Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L124) #### Inherited from @@ -1036,7 +1036,7 @@ Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/ > **pathAlign**: [`TPathAlign`](/api/type-aliases/tpathalign/) -Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L117) +Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L118) #### Inherited from @@ -1048,7 +1048,7 @@ Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/ > **pathSide**: [`TPathSide`](/api/type-aliases/tpathside/) -Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L116) +Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L117) #### Inherited from @@ -1060,7 +1060,7 @@ Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/ > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1074,7 +1074,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -1094,7 +1094,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -1114,7 +1114,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1129,7 +1129,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1148,7 +1148,7 @@ This API is no longer supported and may be removed in a future release. > **selectionEnd**: `number` -Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L71) +Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L71) #### Inherited from @@ -1160,7 +1160,7 @@ Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js > **selectionStart**: `number` -Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L70) +Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L70) #### Inherited from @@ -1172,7 +1172,7 @@ Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1192,7 +1192,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1212,7 +1212,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1232,7 +1232,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1246,7 +1246,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1261,7 +1261,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1282,7 +1282,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1302,7 +1302,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1322,7 +1322,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1342,7 +1342,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1356,7 +1356,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1376,7 +1376,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1409,7 +1409,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1429,7 +1429,7 @@ Width of a stroke used to render this object > **styles**: [`TextStyle`](/api/type-aliases/textstyle/) -Defined in: [src/shapes/Text/Text.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L133) +Defined in: [src/shapes/Text/Text.ts:135](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L135) #### Inherited from @@ -1441,7 +1441,7 @@ Defined in: [src/shapes/Text/Text.ts:133](https://github.com/fabricjs/fabric.js/ > **textAlign**: `TextAlign` -Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L121) +Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L122) #### Inherited from @@ -1449,11 +1449,23 @@ Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/ *** +### textDecorationColor? + +> `optional` **textDecorationColor**: `string` + +Defined in: [src/shapes/Text/Text.ts:126](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L126) + +#### Inherited from + +[`TextProps`](/api/interfaces/textprops/).[`textDecorationColor`](/api/interfaces/textprops/#textdecorationcolor) + +*** + ### textDecorationThickness > **textDecorationThickness**: `number` -Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L124) +Defined in: [src/shapes/Text/Text.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L125) #### Inherited from @@ -1465,7 +1477,7 @@ Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/ > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1487,7 +1499,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1507,7 +1519,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1527,7 +1539,7 @@ true > **underline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L118) +Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L119) #### Inherited from @@ -1539,7 +1551,7 @@ Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/ > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1553,7 +1565,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/ImageProps.md b/src/content/docs/api/interfaces/ImageProps.md index 992703cb..d604334e 100644 --- a/src/content/docs/api/interfaces/ImageProps.md +++ b/src/content/docs/api/interfaces/ImageProps.md @@ -5,7 +5,7 @@ prev: false title: "ImageProps" --- -Defined in: [src/shapes/Image.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L82) +Defined in: [src/shapes/Image.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L82) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Image.ts:82](https://github.com/fabricjs/fabric.js/blob/ > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -42,7 +42,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -62,7 +62,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -77,7 +77,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -97,7 +97,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -115,7 +115,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -135,7 +135,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -159,7 +159,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -171,7 +171,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -193,7 +193,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -212,7 +212,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -229,7 +229,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -249,7 +249,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -273,7 +273,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -293,7 +293,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -317,7 +317,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -347,7 +347,7 @@ This API is no longer supported and may be removed in a future release. > **cropX**: `number` -Defined in: [src/shapes/Image.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L57) +Defined in: [src/shapes/Image.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L57) #### Inherited from @@ -359,7 +359,7 @@ Defined in: [src/shapes/Image.ts:57](https://github.com/fabricjs/fabric.js/blob/ > **cropY**: `number` -Defined in: [src/shapes/Image.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L58) +Defined in: [src/shapes/Image.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L58) #### Inherited from @@ -371,7 +371,7 @@ Defined in: [src/shapes/Image.ts:58](https://github.com/fabricjs/fabric.js/blob/ > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -385,7 +385,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -403,7 +403,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -424,7 +424,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -444,9 +444,9 @@ nonzero ### filters -> **filters**: [`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\>[] +> **filters**: [`BaseFilter`](/api/fabric/namespaces/filters/classes/basefilter/)\<`string`, `object`, `object`\>[] -Defined in: [src/shapes/Image.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L60) +Defined in: [src/shapes/Image.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L60) #### Inherited from @@ -458,7 +458,7 @@ Defined in: [src/shapes/Image.ts:60](https://github.com/fabricjs/fabric.js/blob/ > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -478,7 +478,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -498,7 +498,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -512,7 +512,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -526,7 +526,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -546,7 +546,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -560,7 +560,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -580,7 +580,7 @@ null > **imageSmoothing**: `boolean` -Defined in: [src/shapes/Image.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L59) +Defined in: [src/shapes/Image.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L59) #### Inherited from @@ -592,7 +592,7 @@ Defined in: [src/shapes/Image.ts:59](https://github.com/fabricjs/fabric.js/blob/ > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -606,7 +606,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -628,7 +628,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -650,7 +650,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -664,7 +664,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -678,7 +678,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -692,7 +692,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -706,7 +706,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -720,7 +720,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -734,7 +734,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -748,7 +748,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -762,7 +762,7 @@ When `true`, object vertical skewing is locked > **minimumScaleTrigger**: `number` -Defined in: [src/shapes/Image.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L56) +Defined in: [src/shapes/Image.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L56) #### Inherited from @@ -774,7 +774,7 @@ Defined in: [src/shapes/Image.ts:56](https://github.com/fabricjs/fabric.js/blob/ > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -794,7 +794,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -814,11 +814,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -838,7 +838,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -864,7 +864,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -884,7 +884,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -911,7 +911,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -938,7 +938,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -958,7 +958,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -972,7 +972,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -986,7 +986,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > `optional` **resizeFilter**: [`Resize`](/api/fabric/namespaces/filters/classes/resize/) -Defined in: [src/shapes/Image.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L61) +Defined in: [src/shapes/Image.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L61) #### Inherited from @@ -998,7 +998,7 @@ Defined in: [src/shapes/Image.ts:61](https://github.com/fabricjs/fabric.js/blob/ > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -1018,7 +1018,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -1038,7 +1038,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1053,7 +1053,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1072,7 +1072,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1092,7 +1092,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1112,7 +1112,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1132,7 +1132,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1146,7 +1146,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1161,7 +1161,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **srcFromAttribute**: `boolean` -Defined in: [src/shapes/Image.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L55) +Defined in: [src/shapes/Image.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L55) #### Inherited from @@ -1173,7 +1173,7 @@ Defined in: [src/shapes/Image.ts:55](https://github.com/fabricjs/fabric.js/blob/ > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1194,7 +1194,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1214,7 +1214,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1234,7 +1234,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1254,7 +1254,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1268,7 +1268,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1288,7 +1288,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1321,7 +1321,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1341,7 +1341,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1363,7 +1363,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1383,7 +1383,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1403,7 +1403,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1417,7 +1417,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/MiscEvents.md b/src/content/docs/api/interfaces/MiscEvents.md index 827751b8..c652dfc3 100644 --- a/src/content/docs/api/interfaces/MiscEvents.md +++ b/src/content/docs/api/interfaces/MiscEvents.md @@ -5,7 +5,7 @@ prev: false title: "MiscEvents" --- -Defined in: [src/EventTypeDefs.ts:288](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L288) +Defined in: [src/EventTypeDefs.ts:292](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L292) ## Extended by @@ -18,7 +18,7 @@ Defined in: [src/EventTypeDefs.ts:288](https://github.com/fabricjs/fabric.js/blo > **contextmenu**: `SimpleEventHandler`\<`Event`\> -Defined in: [src/EventTypeDefs.ts:290](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L290) +Defined in: [src/EventTypeDefs.ts:294](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L294) *** @@ -26,4 +26,4 @@ Defined in: [src/EventTypeDefs.ts:290](https://github.com/fabricjs/fabric.js/blo > **contextmenu:before**: `SimpleEventHandler`\<`Event`\> -Defined in: [src/EventTypeDefs.ts:289](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L289) +Defined in: [src/EventTypeDefs.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L293) diff --git a/src/content/docs/api/interfaces/ModifiedEvent.md b/src/content/docs/api/interfaces/ModifiedEvent.md index f3068387..501a4150 100644 --- a/src/content/docs/api/interfaces/ModifiedEvent.md +++ b/src/content/docs/api/interfaces/ModifiedEvent.md @@ -5,7 +5,7 @@ prev: false title: "ModifiedEvent" --- -Defined in: [src/EventTypeDefs.ts:130](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L130) +Defined in: [src/EventTypeDefs.ts:130](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L130) ## Type Parameters @@ -19,7 +19,7 @@ Defined in: [src/EventTypeDefs.ts:130](https://github.com/fabricjs/fabric.js/blo > `optional` **action**: `string` -Defined in: [src/EventTypeDefs.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L134) +Defined in: [src/EventTypeDefs.ts:134](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L134) *** @@ -27,7 +27,7 @@ Defined in: [src/EventTypeDefs.ts:134](https://github.com/fabricjs/fabric.js/blo > `optional` **e**: `E` -Defined in: [src/EventTypeDefs.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L131) +Defined in: [src/EventTypeDefs.ts:131](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L131) *** @@ -35,7 +35,7 @@ Defined in: [src/EventTypeDefs.ts:131](https://github.com/fabricjs/fabric.js/blo > **target**: [`FabricObject`](/api/classes/fabricobject/) -Defined in: [src/EventTypeDefs.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L133) +Defined in: [src/EventTypeDefs.ts:133](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L133) *** @@ -43,4 +43,4 @@ Defined in: [src/EventTypeDefs.ts:133](https://github.com/fabricjs/fabric.js/blo > `optional` **transform**: [`Transform`](/api/type-aliases/transform/) -Defined in: [src/EventTypeDefs.ts:132](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L132) +Defined in: [src/EventTypeDefs.ts:132](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L132) diff --git a/src/content/docs/api/interfaces/ModifyPathEvent.md b/src/content/docs/api/interfaces/ModifyPathEvent.md index bc6dbcad..56e8a58f 100644 --- a/src/content/docs/api/interfaces/ModifyPathEvent.md +++ b/src/content/docs/api/interfaces/ModifyPathEvent.md @@ -5,7 +5,7 @@ prev: false title: "ModifyPathEvent" --- -Defined in: [src/EventTypeDefs.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L137) +Defined in: [src/EventTypeDefs.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L137) ## Properties @@ -13,7 +13,7 @@ Defined in: [src/EventTypeDefs.ts:137](https://github.com/fabricjs/fabric.js/blo > **commandIndex**: `number` -Defined in: [src/EventTypeDefs.ts:138](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L138) +Defined in: [src/EventTypeDefs.ts:138](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L138) *** @@ -21,4 +21,4 @@ Defined in: [src/EventTypeDefs.ts:138](https://github.com/fabricjs/fabric.js/blo > **pointIndex**: `number` -Defined in: [src/EventTypeDefs.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L139) +Defined in: [src/EventTypeDefs.ts:139](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L139) diff --git a/src/content/docs/api/interfaces/ObjectEvents.md b/src/content/docs/api/interfaces/ObjectEvents.md index 4429c15f..466e74f6 100644 --- a/src/content/docs/api/interfaces/ObjectEvents.md +++ b/src/content/docs/api/interfaces/ObjectEvents.md @@ -5,7 +5,7 @@ prev: false title: "ObjectEvents" --- -Defined in: [src/EventTypeDefs.ts:293](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L293) +Defined in: [src/EventTypeDefs.ts:297](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L297) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/EventTypeDefs.ts:293](https://github.com/fabricjs/fabric.js/blo > **added**: `object` -Defined in: [src/EventTypeDefs.ts:303](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L303) +Defined in: [src/EventTypeDefs.ts:307](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L307) #### target @@ -33,7 +33,7 @@ Defined in: [src/EventTypeDefs.ts:303](https://github.com/fabricjs/fabric.js/blo > **before:render**: `object` -Defined in: [src/EventTypeDefs.ts:308](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L308) +Defined in: [src/EventTypeDefs.ts:312](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L312) #### ctx @@ -45,7 +45,7 @@ Defined in: [src/EventTypeDefs.ts:308](https://github.com/fabricjs/fabric.js/blo > **contextmenu**: `SimpleEventHandler`\<`Event`\> -Defined in: [src/EventTypeDefs.ts:290](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L290) +Defined in: [src/EventTypeDefs.ts:294](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L294) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [src/EventTypeDefs.ts:290](https://github.com/fabricjs/fabric.js/blo > **contextmenu:before**: `SimpleEventHandler`\<`Event`\> -Defined in: [src/EventTypeDefs.ts:289](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L289) +Defined in: [src/EventTypeDefs.ts:293](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L293) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [src/EventTypeDefs.ts:289](https://github.com/fabricjs/fabric.js/blo > **deselected**: `Partial`\<[`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\>\> & `object` -Defined in: [src/EventTypeDefs.ts:299](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L299) +Defined in: [src/EventTypeDefs.ts:303](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L303) #### Type Declaration @@ -83,7 +83,7 @@ Defined in: [src/EventTypeDefs.ts:299](https://github.com/fabricjs/fabric.js/blo > **drag**: [`DragEventData`](/api/interfaces/drageventdata/) -Defined in: [src/EventTypeDefs.ts:208](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L208) +Defined in: [src/EventTypeDefs.ts:212](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L212) #### Inherited from @@ -95,7 +95,7 @@ Defined in: [src/EventTypeDefs.ts:208](https://github.com/fabricjs/fabric.js/blo > **dragend**: [`DragEventData`](/api/interfaces/drageventdata/) -Defined in: [src/EventTypeDefs.ts:212](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L212) +Defined in: [src/EventTypeDefs.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L216) #### Inherited from @@ -107,7 +107,7 @@ Defined in: [src/EventTypeDefs.ts:212](https://github.com/fabricjs/fabric.js/blo > **dragenter**: [`DragEventData`](/api/interfaces/drageventdata/) & `InEvent` -Defined in: [src/EventTypeDefs.ts:210](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L210) +Defined in: [src/EventTypeDefs.ts:214](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L214) #### Inherited from @@ -119,7 +119,7 @@ Defined in: [src/EventTypeDefs.ts:210](https://github.com/fabricjs/fabric.js/blo > **dragleave**: [`DragEventData`](/api/interfaces/drageventdata/) & `OutEvent` -Defined in: [src/EventTypeDefs.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L211) +Defined in: [src/EventTypeDefs.ts:215](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L215) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [src/EventTypeDefs.ts:211](https://github.com/fabricjs/fabric.js/blo > **dragover**: [`DragEventData`](/api/interfaces/drageventdata/) -Defined in: [src/EventTypeDefs.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L209) +Defined in: [src/EventTypeDefs.ts:213](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L213) #### Inherited from @@ -143,7 +143,7 @@ Defined in: [src/EventTypeDefs.ts:209](https://github.com/fabricjs/fabric.js/blo > **dragstart**: `TEventWithTarget`\<`DragEvent`\> -Defined in: [src/EventTypeDefs.ts:207](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L207) +Defined in: [src/EventTypeDefs.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L211) #### Inherited from @@ -155,7 +155,7 @@ Defined in: [src/EventTypeDefs.ts:207](https://github.com/fabricjs/fabric.js/blo > **drop**: [`DropEventData`](/api/interfaces/dropeventdata/) -Defined in: [src/EventTypeDefs.ts:214](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L214) +Defined in: [src/EventTypeDefs.ts:218](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L218) #### Inherited from @@ -167,7 +167,7 @@ Defined in: [src/EventTypeDefs.ts:214](https://github.com/fabricjs/fabric.js/blo > **drop:after**: [`DropEventData`](/api/interfaces/dropeventdata/) -Defined in: [src/EventTypeDefs.ts:215](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L215) +Defined in: [src/EventTypeDefs.ts:219](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L219) #### Inherited from @@ -179,7 +179,7 @@ Defined in: [src/EventTypeDefs.ts:215](https://github.com/fabricjs/fabric.js/blo > **drop:before**: [`DropEventData`](/api/interfaces/dropeventdata/) -Defined in: [src/EventTypeDefs.ts:213](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L213) +Defined in: [src/EventTypeDefs.ts:217](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L217) #### Inherited from @@ -191,7 +191,7 @@ Defined in: [src/EventTypeDefs.ts:213](https://github.com/fabricjs/fabric.js/blo > **erasing:end**: `object` -Defined in: [src/EventTypeDefs.ts:307](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L307) +Defined in: [src/EventTypeDefs.ts:311](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L311) #### path @@ -203,7 +203,7 @@ Defined in: [src/EventTypeDefs.ts:307](https://github.com/fabricjs/fabric.js/blo > **modified**: [`ModifiedEvent`](/api/interfaces/modifiedevent/) -Defined in: [src/EventTypeDefs.ts:150](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L150) +Defined in: [src/EventTypeDefs.ts:150](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L150) #### Inherited from @@ -215,7 +215,7 @@ Defined in: [src/EventTypeDefs.ts:150](https://github.com/fabricjs/fabric.js/blo > **modifyPath**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\> & [`ModifyPathEvent`](/api/interfaces/modifypathevent/) -Defined in: [src/EventTypeDefs.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L149) +Defined in: [src/EventTypeDefs.ts:149](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L149) #### Inherited from @@ -227,7 +227,7 @@ Defined in: [src/EventTypeDefs.ts:149](https://github.com/fabricjs/fabric.js/blo > **modifyPoly**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L148) +Defined in: [src/EventTypeDefs.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L148) #### Inherited from @@ -370,7 +370,7 @@ before the cycle of mouse down -> mouse up started > **moving**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:143](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L143) +Defined in: [src/EventTypeDefs.ts:143](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L143) #### Inherited from @@ -398,7 +398,7 @@ Defined in: [src/EventTypeDefs.ts:143](https://github.com/fabricjs/fabric.js/blo > **removed**: `object` -Defined in: [src/EventTypeDefs.ts:304](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L304) +Defined in: [src/EventTypeDefs.ts:308](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L308) #### target @@ -410,7 +410,7 @@ Defined in: [src/EventTypeDefs.ts:304](https://github.com/fabricjs/fabric.js/blo > **resizing**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:147](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L147) +Defined in: [src/EventTypeDefs.ts:147](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L147) #### Inherited from @@ -438,7 +438,7 @@ Defined in: [src/EventTypeDefs.ts:147](https://github.com/fabricjs/fabric.js/blo > **rotating**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:145](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L145) +Defined in: [src/EventTypeDefs.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L145) #### Inherited from @@ -450,7 +450,7 @@ Defined in: [src/EventTypeDefs.ts:145](https://github.com/fabricjs/fabric.js/blo > **scaling**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:144](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L144) +Defined in: [src/EventTypeDefs.ts:144](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L144) #### Inherited from @@ -462,7 +462,7 @@ Defined in: [src/EventTypeDefs.ts:144](https://github.com/fabricjs/fabric.js/blo > **selected**: `Partial`\<[`TEvent`](/api/interfaces/tevent/)\<[`TPointerEvent`](/api/type-aliases/tpointerevent/)\>\> & `object` -Defined in: [src/EventTypeDefs.ts:296](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L296) +Defined in: [src/EventTypeDefs.ts:300](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L300) #### Type Declaration @@ -476,7 +476,7 @@ Defined in: [src/EventTypeDefs.ts:296](https://github.com/fabricjs/fabric.js/blo > **skewing**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L146) +Defined in: [src/EventTypeDefs.ts:146](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L146) #### Inherited from diff --git a/src/content/docs/api/interfaces/PathProps.md b/src/content/docs/api/interfaces/PathProps.md index 371df173..2f233a7e 100644 --- a/src/content/docs/api/interfaces/PathProps.md +++ b/src/content/docs/api/interfaces/PathProps.md @@ -5,7 +5,7 @@ prev: false title: "PathProps" --- -Defined in: [src/shapes/Path.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L40) +Defined in: [src/shapes/Path.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L40) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Path.ts:40](https://github.com/fabricjs/fabric.js/blob/2 > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -42,7 +42,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -62,7 +62,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -77,7 +77,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -97,7 +97,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -115,7 +115,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -135,7 +135,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -159,7 +159,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -171,7 +171,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -193,7 +193,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -212,7 +212,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -229,7 +229,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -249,7 +249,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -273,7 +273,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -293,7 +293,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -317,7 +317,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -347,7 +347,7 @@ This API is no longer supported and may be removed in a future release. > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -361,7 +361,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -379,7 +379,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -400,7 +400,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -422,7 +422,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -442,7 +442,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -462,7 +462,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -476,7 +476,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -490,7 +490,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -510,7 +510,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -524,7 +524,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -544,7 +544,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -558,7 +558,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -580,7 +580,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -602,7 +602,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -616,7 +616,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -630,7 +630,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -644,7 +644,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -658,7 +658,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -672,7 +672,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -686,7 +686,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -700,7 +700,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -714,7 +714,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -734,7 +734,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -754,11 +754,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -778,7 +778,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -804,7 +804,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -824,7 +824,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -851,7 +851,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -878,7 +878,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -898,7 +898,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -912,7 +912,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **path**: [`TSimplePathData`](/api/type-aliases/tsimplepathdata/) -Defined in: [src/shapes/Path.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L34) +Defined in: [src/shapes/Path.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L34) #### Inherited from @@ -924,7 +924,7 @@ Defined in: [src/shapes/Path.ts:34](https://github.com/fabricjs/fabric.js/blob/2 > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -938,7 +938,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -958,7 +958,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -978,7 +978,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -993,7 +993,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1012,7 +1012,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1032,7 +1032,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1052,7 +1052,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1072,7 +1072,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1086,7 +1086,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1101,7 +1101,7 @@ When undefined, the snapThreshold will default to the snapAngle. > `optional` **sourcePath**: `string` -Defined in: [src/shapes/Path.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L33) +Defined in: [src/shapes/Path.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L33) #### Inherited from @@ -1113,7 +1113,7 @@ Defined in: [src/shapes/Path.ts:33](https://github.com/fabricjs/fabric.js/blob/2 > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1134,7 +1134,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1154,7 +1154,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1174,7 +1174,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1194,7 +1194,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1208,7 +1208,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1228,7 +1228,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1261,7 +1261,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1281,7 +1281,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1303,7 +1303,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1323,7 +1323,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1343,7 +1343,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1357,7 +1357,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/RectProps.md b/src/content/docs/api/interfaces/RectProps.md index aba31653..d1f3ed37 100644 --- a/src/content/docs/api/interfaces/RectProps.md +++ b/src/content/docs/api/interfaces/RectProps.md @@ -5,7 +5,7 @@ prev: false title: "RectProps" --- -Defined in: [src/shapes/Rect.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L25) +Defined in: [src/shapes/Rect.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L25) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Rect.ts:25](https://github.com/fabricjs/fabric.js/blob/2 > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -42,7 +42,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -62,7 +62,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -77,7 +77,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -97,7 +97,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -115,7 +115,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -135,7 +135,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -159,7 +159,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -171,7 +171,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -193,7 +193,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -212,7 +212,7 @@ when being scaled via the controls. > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -229,7 +229,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -249,7 +249,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -273,7 +273,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -293,7 +293,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -317,7 +317,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -347,7 +347,7 @@ This API is no longer supported and may be removed in a future release. > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -361,7 +361,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -379,7 +379,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -400,7 +400,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -422,7 +422,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -442,7 +442,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -462,7 +462,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -476,7 +476,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -490,7 +490,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -510,7 +510,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -524,7 +524,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -544,7 +544,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -558,7 +558,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -580,7 +580,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -602,7 +602,7 @@ You can change this by setting originX > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -616,7 +616,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -630,7 +630,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -644,7 +644,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -658,7 +658,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -672,7 +672,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -686,7 +686,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -700,7 +700,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -714,7 +714,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -734,7 +734,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -754,11 +754,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -778,7 +778,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -804,7 +804,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -824,7 +824,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -851,7 +851,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -878,7 +878,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -898,7 +898,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -912,7 +912,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -926,7 +926,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **rx**: `number` -Defined in: [src/shapes/Rect.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L18) +Defined in: [src/shapes/Rect.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L18) #### Inherited from @@ -938,7 +938,7 @@ Defined in: [src/shapes/Rect.ts:18](https://github.com/fabricjs/fabric.js/blob/2 > **ry**: `number` -Defined in: [src/shapes/Rect.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L19) +Defined in: [src/shapes/Rect.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L19) #### Inherited from @@ -950,7 +950,7 @@ Defined in: [src/shapes/Rect.ts:19](https://github.com/fabricjs/fabric.js/blob/2 > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -970,7 +970,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -990,7 +990,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1005,7 +1005,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1024,7 +1024,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1044,7 +1044,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1064,7 +1064,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1084,7 +1084,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1098,7 +1098,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1113,7 +1113,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1134,7 +1134,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1154,7 +1154,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1174,7 +1174,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1194,7 +1194,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1208,7 +1208,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1228,7 +1228,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1261,7 +1261,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1281,7 +1281,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1303,7 +1303,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1323,7 +1323,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1343,7 +1343,7 @@ true > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1357,7 +1357,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedCircleProps.md b/src/content/docs/api/interfaces/SerializedCircleProps.md index 016755a6..6a737609 100644 --- a/src/content/docs/api/interfaces/SerializedCircleProps.md +++ b/src/content/docs/api/interfaces/SerializedCircleProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedCircleProps" --- -Defined in: [src/shapes/Circle.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L46) +Defined in: [src/shapes/Circle.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L46) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Circle.ts:46](https://github.com/fabricjs/fabric.js/blob > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -37,7 +37,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -52,7 +52,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -69,7 +69,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **counterClockwise**: `boolean` -Defined in: [src/shapes/Circle.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L43) +Defined in: [src/shapes/Circle.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L43) Orientation for the direction of the circle. Setting to true will switch the arc of the circle to traverse from startAngle to endAngle in a counter-clockwise direction. @@ -91,7 +91,7 @@ false > **endAngle**: `number` -Defined in: [src/shapes/Circle.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L35) +Defined in: [src/shapes/Circle.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L35) Angle for the end of the circle, in degrees @@ -111,7 +111,7 @@ Angle for the end of the circle, in degrees > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -132,7 +132,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -154,7 +154,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -174,7 +174,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -194,7 +194,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -208,7 +208,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -222,7 +222,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -244,7 +244,7 @@ You can change this by setting originX > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -264,7 +264,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -291,7 +291,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -318,7 +318,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -332,7 +332,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **radius**: `number` -Defined in: [src/shapes/Circle.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L21) +Defined in: [src/shapes/Circle.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L21) Radius of this circle @@ -352,7 +352,7 @@ Radius of this circle > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -372,7 +372,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -392,7 +392,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -412,7 +412,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -432,7 +432,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -452,7 +452,7 @@ Angle of skew on y axes of an object (in degrees) > **startAngle**: `number` -Defined in: [src/shapes/Circle.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Circle.ts#L28) +Defined in: [src/shapes/Circle.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Circle.ts#L28) Angle for the start of the circle, in degrees. @@ -472,7 +472,7 @@ Angle for the start of the circle, in degrees. > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -493,7 +493,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -513,7 +513,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -533,7 +533,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -553,7 +553,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -567,7 +567,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -587,7 +587,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -620,7 +620,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -640,7 +640,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -662,7 +662,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -676,7 +676,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedEllipseProps.md b/src/content/docs/api/interfaces/SerializedEllipseProps.md index bf550c0f..65d0cbec 100644 --- a/src/content/docs/api/interfaces/SerializedEllipseProps.md +++ b/src/content/docs/api/interfaces/SerializedEllipseProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedEllipseProps" --- -Defined in: [src/shapes/Ellipse.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L22) +Defined in: [src/shapes/Ellipse.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L22) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Ellipse.ts:22](https://github.com/fabricjs/fabric.js/blo > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -37,7 +37,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -52,7 +52,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -69,7 +69,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -90,7 +90,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -112,7 +112,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -132,7 +132,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -152,7 +152,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -166,7 +166,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -180,7 +180,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -202,7 +202,7 @@ You can change this by setting originX > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -222,7 +222,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -249,7 +249,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -276,7 +276,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -290,7 +290,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **rx**: `number` -Defined in: [src/shapes/Ellipse.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L18) +Defined in: [src/shapes/Ellipse.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L18) #### Inherited from @@ -302,7 +302,7 @@ Defined in: [src/shapes/Ellipse.ts:18](https://github.com/fabricjs/fabric.js/blo > **ry**: `number` -Defined in: [src/shapes/Ellipse.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Ellipse.ts#L19) +Defined in: [src/shapes/Ellipse.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Ellipse.ts#L19) #### Inherited from @@ -314,7 +314,7 @@ Defined in: [src/shapes/Ellipse.ts:19](https://github.com/fabricjs/fabric.js/blo > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -334,7 +334,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -354,7 +354,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -374,7 +374,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -394,7 +394,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -414,7 +414,7 @@ Angle of skew on y axes of an object (in degrees) > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -435,7 +435,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -455,7 +455,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -475,7 +475,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -495,7 +495,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -509,7 +509,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -529,7 +529,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -562,7 +562,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -582,7 +582,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -604,7 +604,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -618,7 +618,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedGroupProps.md b/src/content/docs/api/interfaces/SerializedGroupProps.md index d64f36db..4665597d 100644 --- a/src/content/docs/api/interfaces/SerializedGroupProps.md +++ b/src/content/docs/api/interfaces/SerializedGroupProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedGroupProps" --- -Defined in: [src/shapes/Group.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L60) +Defined in: [src/shapes/Group.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L60) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Group.ts:60](https://github.com/fabricjs/fabric.js/blob/ > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -37,7 +37,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -52,7 +52,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -69,7 +69,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -90,7 +90,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -112,7 +112,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -132,7 +132,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -152,7 +152,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -166,7 +166,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -180,7 +180,7 @@ Object height > **interactive**: `boolean` -Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L57) +Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L57) #### Inherited from @@ -192,7 +192,7 @@ Defined in: [src/shapes/Group.ts:57](https://github.com/fabricjs/fabric.js/blob/ > **layoutManager**: [`SerializedLayoutManager`](/api/type-aliases/serializedlayoutmanager/) -Defined in: [src/shapes/Group.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L63) +Defined in: [src/shapes/Group.ts:63](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L63) *** @@ -200,7 +200,7 @@ Defined in: [src/shapes/Group.ts:63](https://github.com/fabricjs/fabric.js/blob/ > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -222,7 +222,7 @@ You can change this by setting originX > **objects**: [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/)[] -Defined in: [src/shapes/Group.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L62) +Defined in: [src/shapes/Group.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L62) *** @@ -230,7 +230,7 @@ Defined in: [src/shapes/Group.ts:62](https://github.com/fabricjs/fabric.js/blob/ > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -250,7 +250,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -277,7 +277,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -304,7 +304,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -318,7 +318,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -338,7 +338,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -358,7 +358,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -378,7 +378,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -398,7 +398,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -418,7 +418,7 @@ Angle of skew on y axes of an object (in degrees) > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -439,7 +439,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -459,7 +459,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -479,7 +479,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -499,7 +499,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -513,7 +513,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -533,7 +533,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -566,7 +566,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -586,7 +586,7 @@ Width of a stroke used to render this object > **subTargetCheck**: `boolean` -Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Group.ts#L56) +Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Group.ts#L56) #### Inherited from @@ -598,7 +598,7 @@ Defined in: [src/shapes/Group.ts:56](https://github.com/fabricjs/fabric.js/blob/ > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -620,7 +620,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -634,7 +634,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedITextProps.md b/src/content/docs/api/interfaces/SerializedITextProps.md index daf54567..90addd93 100644 --- a/src/content/docs/api/interfaces/SerializedITextProps.md +++ b/src/content/docs/api/interfaces/SerializedITextProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedITextProps" --- -Defined in: [src/shapes/IText/IText.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L74) +Defined in: [src/shapes/IText/IText.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L74) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/shapes/IText/IText.ts:74](https://github.com/fabricjs/fabric.js > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -41,7 +41,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -56,7 +56,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **charSpacing**: `number` -Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L110) +Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L111) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -85,7 +85,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **direction**: `CanvasDirection` -Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L122) +Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L123) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/ > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -118,7 +118,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -140,7 +140,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -160,7 +160,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -180,7 +180,7 @@ false > **fontFamily**: `string` -Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L114) +Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L115) #### Inherited from @@ -192,7 +192,7 @@ Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/ > **fontSize**: `number` -Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L112) +Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L113) #### Inherited from @@ -204,7 +204,7 @@ Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/ > **fontStyle**: `FontStyle` -Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L115) +Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L116) #### Inherited from @@ -216,7 +216,7 @@ Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/ > **fontWeight**: `string` \| `number` -Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L113) +Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L114) #### Inherited from @@ -228,7 +228,7 @@ Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/ > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -242,7 +242,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -256,7 +256,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -278,7 +278,7 @@ You can change this by setting originX > **lineHeight**: `number` -Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L111) +Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L112) #### Inherited from @@ -290,7 +290,7 @@ Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/ > **linethrough**: `boolean` -Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L120) +Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L121) #### Inherited from @@ -302,7 +302,7 @@ Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/ > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -322,7 +322,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -349,7 +349,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -376,7 +376,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **overline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L119) +Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L120) #### Inherited from @@ -388,7 +388,7 @@ Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/ > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -402,7 +402,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **path**: [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L123) +Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L124) #### Inherited from @@ -414,7 +414,7 @@ Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/ > **pathAlign**: [`TPathAlign`](/api/type-aliases/tpathalign/) -Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L117) +Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L118) #### Inherited from @@ -426,7 +426,7 @@ Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/ > **pathSide**: [`TPathSide`](/api/type-aliases/tpathside/) -Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L116) +Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L117) #### Inherited from @@ -438,7 +438,7 @@ Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/ > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -458,7 +458,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -478,7 +478,7 @@ Object scale factor (vertical) > **selectionEnd**: `number` -Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L71) +Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L71) #### Inherited from @@ -490,7 +490,7 @@ Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js > **selectionStart**: `number` -Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L70) +Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L70) #### Inherited from @@ -502,7 +502,7 @@ Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -522,7 +522,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -542,7 +542,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -562,7 +562,7 @@ Angle of skew on y axes of an object (in degrees) > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -583,7 +583,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -603,7 +603,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -623,7 +623,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -643,7 +643,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -657,7 +657,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -677,7 +677,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -710,7 +710,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -730,7 +730,7 @@ Width of a stroke used to render this object > **styles**: [`TextStyle`](/api/type-aliases/textstyle/) \| [`TextStyleArray`](/api/fabric/namespaces/util/type-aliases/textstylearray/) -Defined in: [src/shapes/Text/Text.ts:129](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L129) +Defined in: [src/shapes/Text/Text.ts:131](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L131) #### Inherited from @@ -742,7 +742,7 @@ Defined in: [src/shapes/Text/Text.ts:129](https://github.com/fabricjs/fabric.js/ > **textAlign**: `TextAlign` -Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L121) +Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L122) #### Inherited from @@ -750,11 +750,23 @@ Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/ *** +### textDecorationColor? + +> `optional` **textDecorationColor**: `string` + +Defined in: [src/shapes/Text/Text.ts:126](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L126) + +#### Inherited from + +[`SerializedTextProps`](/api/interfaces/serializedtextprops/).[`textDecorationColor`](/api/interfaces/serializedtextprops/#textdecorationcolor) + +*** + ### textDecorationThickness > **textDecorationThickness**: `number` -Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L124) +Defined in: [src/shapes/Text/Text.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L125) #### Inherited from @@ -766,7 +778,7 @@ Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/ > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -788,7 +800,7 @@ You can change this by setting originY > **underline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L118) +Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L119) #### Inherited from @@ -800,7 +812,7 @@ Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/ > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -814,7 +826,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedImageProps.md b/src/content/docs/api/interfaces/SerializedImageProps.md index fbc6e3be..d962c88a 100644 --- a/src/content/docs/api/interfaces/SerializedImageProps.md +++ b/src/content/docs/api/interfaces/SerializedImageProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedImageProps" --- -Defined in: [src/shapes/Image.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L73) +Defined in: [src/shapes/Image.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L73) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Image.ts:73](https://github.com/fabricjs/fabric.js/blob/ > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -37,7 +37,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -52,7 +52,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -69,7 +69,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cropX**: `number` -Defined in: [src/shapes/Image.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L78) +Defined in: [src/shapes/Image.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L78) *** @@ -77,7 +77,7 @@ Defined in: [src/shapes/Image.ts:78](https://github.com/fabricjs/fabric.js/blob/ > **cropY**: `number` -Defined in: [src/shapes/Image.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L79) +Defined in: [src/shapes/Image.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L79) *** @@ -85,7 +85,7 @@ Defined in: [src/shapes/Image.ts:79](https://github.com/fabricjs/fabric.js/blob/ > **crossOrigin**: [`TCrossOrigin`](/api/type-aliases/tcrossorigin/) -Defined in: [src/shapes/Image.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L75) +Defined in: [src/shapes/Image.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L75) *** @@ -93,7 +93,7 @@ Defined in: [src/shapes/Image.ts:75](https://github.com/fabricjs/fabric.js/blob/ > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -114,7 +114,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -136,7 +136,7 @@ nonzero > **filters**: `any`[] -Defined in: [src/shapes/Image.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L76) +Defined in: [src/shapes/Image.ts:76](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L76) *** @@ -144,7 +144,7 @@ Defined in: [src/shapes/Image.ts:76](https://github.com/fabricjs/fabric.js/blob/ > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -164,7 +164,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -184,7 +184,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -198,7 +198,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -212,7 +212,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -234,7 +234,7 @@ You can change this by setting originX > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -254,7 +254,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -281,7 +281,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -308,7 +308,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -322,7 +322,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **resizeFilter**: `ResizeOwnProps` -Defined in: [src/shapes/Image.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L77) +Defined in: [src/shapes/Image.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L77) *** @@ -330,7 +330,7 @@ Defined in: [src/shapes/Image.ts:77](https://github.com/fabricjs/fabric.js/blob/ > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -350,7 +350,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -370,7 +370,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -390,7 +390,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -410,7 +410,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -430,7 +430,7 @@ Angle of skew on y axes of an object (in degrees) > **src**: `string` -Defined in: [src/shapes/Image.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L74) +Defined in: [src/shapes/Image.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L74) *** @@ -438,7 +438,7 @@ Defined in: [src/shapes/Image.ts:74](https://github.com/fabricjs/fabric.js/blob/ > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -459,7 +459,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -479,7 +479,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -499,7 +499,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -519,7 +519,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -533,7 +533,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -553,7 +553,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -586,7 +586,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -606,7 +606,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -628,7 +628,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -642,7 +642,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedLineProps.md b/src/content/docs/api/interfaces/SerializedLineProps.md index 90a146c4..e99efc01 100644 --- a/src/content/docs/api/interfaces/SerializedLineProps.md +++ b/src/content/docs/api/interfaces/SerializedLineProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedLineProps" --- -Defined in: [src/shapes/Line.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L25) +Defined in: [src/shapes/Line.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L25) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Line.ts:25](https://github.com/fabricjs/fabric.js/blob/2 > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -37,7 +37,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -52,7 +52,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -69,7 +69,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -90,7 +90,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -112,7 +112,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -132,7 +132,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -152,7 +152,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -166,7 +166,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -180,7 +180,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -202,7 +202,7 @@ You can change this by setting originX > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -222,7 +222,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -249,7 +249,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -276,7 +276,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -290,7 +290,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -310,7 +310,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -330,7 +330,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -350,7 +350,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -370,7 +370,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -390,7 +390,7 @@ Angle of skew on y axes of an object (in degrees) > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -411,7 +411,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -431,7 +431,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -451,7 +451,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -471,7 +471,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -485,7 +485,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -505,7 +505,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -538,7 +538,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -558,7 +558,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -580,7 +580,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -594,7 +594,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width @@ -608,7 +608,7 @@ Object width > **x1**: `number` -Defined in: [src/shapes/Line.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L19) +Defined in: [src/shapes/Line.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L19) #### Inherited from @@ -620,7 +620,7 @@ Defined in: [src/shapes/Line.ts:19](https://github.com/fabricjs/fabric.js/blob/2 > **x2**: `number` -Defined in: [src/shapes/Line.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L20) +Defined in: [src/shapes/Line.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L20) #### Inherited from @@ -632,7 +632,7 @@ Defined in: [src/shapes/Line.ts:20](https://github.com/fabricjs/fabric.js/blob/2 > **y1**: `number` -Defined in: [src/shapes/Line.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L21) +Defined in: [src/shapes/Line.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L21) #### Inherited from @@ -644,7 +644,7 @@ Defined in: [src/shapes/Line.ts:21](https://github.com/fabricjs/fabric.js/blob/2 > **y2**: `number` -Defined in: [src/shapes/Line.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Line.ts#L22) +Defined in: [src/shapes/Line.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Line.ts#L22) #### Inherited from diff --git a/src/content/docs/api/interfaces/SerializedObjectProps.md b/src/content/docs/api/interfaces/SerializedObjectProps.md index 0c8b0919..4dc9fbc4 100644 --- a/src/content/docs/api/interfaces/SerializedObjectProps.md +++ b/src/content/docs/api/interfaces/SerializedObjectProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedObjectProps" --- -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:5](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L5) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:5](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L5) ## Extends @@ -29,7 +29,7 @@ Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:5](https://github. > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -49,7 +49,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -60,7 +60,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > `optional` **clipPath**: `Partial`\<`SerializedObjectProps` & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -73,7 +73,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -94,7 +94,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -116,7 +116,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -136,7 +136,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -156,7 +156,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -166,7 +166,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -180,7 +180,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -202,7 +202,7 @@ You can change this by setting originX > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -218,7 +218,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -245,7 +245,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -272,7 +272,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -286,7 +286,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -306,7 +306,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -326,7 +326,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -342,7 +342,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -362,7 +362,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -382,7 +382,7 @@ Angle of skew on y axes of an object (in degrees) > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -403,7 +403,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -423,7 +423,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -443,7 +443,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -463,7 +463,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -477,7 +477,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -497,7 +497,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -530,7 +530,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -550,7 +550,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -572,7 +572,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -582,7 +582,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedPathProps.md b/src/content/docs/api/interfaces/SerializedPathProps.md index f20e3085..b9066b02 100644 --- a/src/content/docs/api/interfaces/SerializedPathProps.md +++ b/src/content/docs/api/interfaces/SerializedPathProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedPathProps" --- -Defined in: [src/shapes/Path.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L37) +Defined in: [src/shapes/Path.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L37) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Path.ts:37](https://github.com/fabricjs/fabric.js/blob/2 > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -37,7 +37,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -52,7 +52,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -69,7 +69,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -90,7 +90,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -112,7 +112,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -132,7 +132,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -152,7 +152,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -166,7 +166,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -180,7 +180,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -202,7 +202,7 @@ You can change this by setting originX > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -222,7 +222,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -249,7 +249,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -276,7 +276,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -290,7 +290,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **path**: [`TSimplePathData`](/api/type-aliases/tsimplepathdata/) -Defined in: [src/shapes/Path.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L34) +Defined in: [src/shapes/Path.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L34) #### Inherited from @@ -302,7 +302,7 @@ Defined in: [src/shapes/Path.ts:34](https://github.com/fabricjs/fabric.js/blob/2 > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -322,7 +322,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -342,7 +342,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -362,7 +362,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -382,7 +382,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -402,7 +402,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **sourcePath**: `string` -Defined in: [src/shapes/Path.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Path.ts#L33) +Defined in: [src/shapes/Path.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Path.ts#L33) #### Inherited from @@ -414,7 +414,7 @@ Defined in: [src/shapes/Path.ts:33](https://github.com/fabricjs/fabric.js/blob/2 > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -435,7 +435,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -455,7 +455,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -475,7 +475,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -495,7 +495,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -509,7 +509,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -529,7 +529,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -562,7 +562,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -582,7 +582,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -604,7 +604,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -618,7 +618,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedPolylineProps.md b/src/content/docs/api/interfaces/SerializedPolylineProps.md index 29369198..73607fe9 100644 --- a/src/content/docs/api/interfaces/SerializedPolylineProps.md +++ b/src/content/docs/api/interfaces/SerializedPolylineProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedPolylineProps" --- -Defined in: [src/shapes/Polyline.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L37) +Defined in: [src/shapes/Polyline.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L37) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Polyline.ts:37](https://github.com/fabricjs/fabric.js/bl > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -37,7 +37,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -52,7 +52,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -69,7 +69,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -90,7 +90,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -112,7 +112,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -132,7 +132,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -152,7 +152,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -166,7 +166,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -180,7 +180,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -202,7 +202,7 @@ You can change this by setting originX > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -222,7 +222,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -249,7 +249,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -276,7 +276,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -290,7 +290,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **points**: [`XY`](/api/interfaces/xy/)[] -Defined in: [src/shapes/Polyline.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Polyline.ts#L38) +Defined in: [src/shapes/Polyline.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Polyline.ts#L38) *** @@ -298,7 +298,7 @@ Defined in: [src/shapes/Polyline.ts:38](https://github.com/fabricjs/fabric.js/bl > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -318,7 +318,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -338,7 +338,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -358,7 +358,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -378,7 +378,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -398,7 +398,7 @@ Angle of skew on y axes of an object (in degrees) > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -419,7 +419,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -439,7 +439,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -459,7 +459,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -479,7 +479,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -493,7 +493,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -513,7 +513,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -546,7 +546,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -566,7 +566,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -588,7 +588,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -602,7 +602,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedRectProps.md b/src/content/docs/api/interfaces/SerializedRectProps.md index 85558a6a..533ebfb4 100644 --- a/src/content/docs/api/interfaces/SerializedRectProps.md +++ b/src/content/docs/api/interfaces/SerializedRectProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedRectProps" --- -Defined in: [src/shapes/Rect.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L22) +Defined in: [src/shapes/Rect.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L22) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Rect.ts:22](https://github.com/fabricjs/fabric.js/blob/2 > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -37,7 +37,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -52,7 +52,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -69,7 +69,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -90,7 +90,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -112,7 +112,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -132,7 +132,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -152,7 +152,7 @@ false > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -166,7 +166,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -180,7 +180,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -202,7 +202,7 @@ You can change this by setting originX > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -222,7 +222,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -249,7 +249,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -276,7 +276,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -290,7 +290,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > **rx**: `number` -Defined in: [src/shapes/Rect.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L18) +Defined in: [src/shapes/Rect.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L18) #### Inherited from @@ -302,7 +302,7 @@ Defined in: [src/shapes/Rect.ts:18](https://github.com/fabricjs/fabric.js/blob/2 > **ry**: `number` -Defined in: [src/shapes/Rect.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Rect.ts#L19) +Defined in: [src/shapes/Rect.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Rect.ts#L19) #### Inherited from @@ -314,7 +314,7 @@ Defined in: [src/shapes/Rect.ts:19](https://github.com/fabricjs/fabric.js/blob/2 > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -334,7 +334,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -354,7 +354,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -374,7 +374,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -394,7 +394,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -414,7 +414,7 @@ Angle of skew on y axes of an object (in degrees) > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -435,7 +435,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -455,7 +455,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -475,7 +475,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -495,7 +495,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -509,7 +509,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -529,7 +529,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -562,7 +562,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -582,7 +582,7 @@ Width of a stroke used to render this object > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -604,7 +604,7 @@ You can change this by setting originY > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -618,7 +618,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedTextProps.md b/src/content/docs/api/interfaces/SerializedTextProps.md index 51a96eff..51c11686 100644 --- a/src/content/docs/api/interfaces/SerializedTextProps.md +++ b/src/content/docs/api/interfaces/SerializedTextProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedTextProps" --- -Defined in: [src/shapes/Text/Text.ts:127](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L127) +Defined in: [src/shapes/Text/Text.ts:129](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L129) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/shapes/Text/Text.ts:127](https://github.com/fabricjs/fabric.js/ > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -41,7 +41,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -56,7 +56,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **charSpacing**: `number` -Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L110) +Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L111) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -85,7 +85,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **direction**: `CanvasDirection` -Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L122) +Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L123) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/ > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -118,7 +118,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -140,7 +140,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -160,7 +160,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -180,7 +180,7 @@ false > **fontFamily**: `string` -Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L114) +Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L115) #### Inherited from @@ -192,7 +192,7 @@ Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/ > **fontSize**: `number` -Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L112) +Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L113) #### Inherited from @@ -204,7 +204,7 @@ Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/ > **fontStyle**: `FontStyle` -Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L115) +Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L116) #### Inherited from @@ -216,7 +216,7 @@ Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/ > **fontWeight**: `string` \| `number` -Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L113) +Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L114) #### Inherited from @@ -228,7 +228,7 @@ Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/ > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -242,7 +242,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -256,7 +256,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -278,7 +278,7 @@ You can change this by setting originX > **lineHeight**: `number` -Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L111) +Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L112) #### Inherited from @@ -290,7 +290,7 @@ Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/ > **linethrough**: `boolean` -Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L120) +Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L121) #### Inherited from @@ -302,7 +302,7 @@ Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/ > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -322,7 +322,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -349,7 +349,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -376,7 +376,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **overline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L119) +Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L120) #### Inherited from @@ -388,7 +388,7 @@ Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/ > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -402,7 +402,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **path**: [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L123) +Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L124) #### Inherited from @@ -414,7 +414,7 @@ Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/ > **pathAlign**: [`TPathAlign`](/api/type-aliases/tpathalign/) -Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L117) +Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L118) #### Inherited from @@ -426,7 +426,7 @@ Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/ > **pathSide**: [`TPathSide`](/api/type-aliases/tpathside/) -Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L116) +Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L117) #### Inherited from @@ -438,7 +438,7 @@ Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/ > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -458,7 +458,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -478,7 +478,7 @@ Object scale factor (vertical) > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -498,7 +498,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -518,7 +518,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -538,7 +538,7 @@ Angle of skew on y axes of an object (in degrees) > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -559,7 +559,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -579,7 +579,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -599,7 +599,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -619,7 +619,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -633,7 +633,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -653,7 +653,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -686,7 +686,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -706,7 +706,7 @@ Width of a stroke used to render this object > **styles**: [`TextStyle`](/api/type-aliases/textstyle/) \| [`TextStyleArray`](/api/fabric/namespaces/util/type-aliases/textstylearray/) -Defined in: [src/shapes/Text/Text.ts:129](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L129) +Defined in: [src/shapes/Text/Text.ts:131](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L131) *** @@ -714,7 +714,7 @@ Defined in: [src/shapes/Text/Text.ts:129](https://github.com/fabricjs/fabric.js/ > **textAlign**: `TextAlign` -Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L121) +Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L122) #### Inherited from @@ -722,11 +722,23 @@ Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/ *** +### textDecorationColor? + +> `optional` **textDecorationColor**: `string` + +Defined in: [src/shapes/Text/Text.ts:126](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L126) + +#### Inherited from + +`UniqueTextProps.textDecorationColor` + +*** + ### textDecorationThickness > **textDecorationThickness**: `number` -Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L124) +Defined in: [src/shapes/Text/Text.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L125) #### Inherited from @@ -738,7 +750,7 @@ Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/ > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -760,7 +772,7 @@ You can change this by setting originY > **underline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L118) +Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L119) #### Inherited from @@ -772,7 +784,7 @@ Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/ > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -786,7 +798,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/SerializedTextboxProps.md b/src/content/docs/api/interfaces/SerializedTextboxProps.md index 95035253..23eb5dbc 100644 --- a/src/content/docs/api/interfaces/SerializedTextboxProps.md +++ b/src/content/docs/api/interfaces/SerializedTextboxProps.md @@ -5,7 +5,7 @@ prev: false title: "SerializedTextboxProps" --- -Defined in: [src/shapes/Textbox.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L42) +Defined in: [src/shapes/Textbox.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L42) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Textbox.ts:42](https://github.com/fabricjs/fabric.js/blo > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -37,7 +37,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -52,7 +52,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **charSpacing**: `number` -Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L110) +Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L111) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/ > `optional` **clipPath**: `Partial`\<[`SerializedObjectProps`](/api/interfaces/serializedobjectprops/) & `ClipPathProps`\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L46) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L46) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -81,7 +81,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **direction**: `CanvasDirection` -Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L122) +Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L123) #### Inherited from @@ -93,7 +93,7 @@ Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/ > **fill**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L16) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L16) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -114,7 +114,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -136,7 +136,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -156,7 +156,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -176,7 +176,7 @@ false > **fontFamily**: `string` -Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L114) +Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L115) #### Inherited from @@ -188,7 +188,7 @@ Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/ > **fontSize**: `number` -Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L112) +Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L113) #### Inherited from @@ -200,7 +200,7 @@ Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/ > **fontStyle**: `FontStyle` -Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L115) +Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L116) #### Inherited from @@ -212,7 +212,7 @@ Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/ > **fontWeight**: `string` \| `number` -Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L113) +Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L114) #### Inherited from @@ -224,7 +224,7 @@ Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/ > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -238,7 +238,7 @@ Composite rule used for canvas globalCompositeOperation > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -252,7 +252,7 @@ Object height > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -274,7 +274,7 @@ You can change this by setting originX > **lineHeight**: `number` -Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L111) +Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L112) #### Inherited from @@ -286,7 +286,7 @@ Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/ > **linethrough**: `boolean` -Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L120) +Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L121) #### Inherited from @@ -298,7 +298,7 @@ Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/ > **minWidth**: `number` -Defined in: [src/shapes/Textbox.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L36) +Defined in: [src/shapes/Textbox.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L36) #### Inherited from @@ -310,7 +310,7 @@ Defined in: [src/shapes/Textbox.ts:36](https://github.com/fabricjs/fabric.js/blo > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -330,7 +330,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -357,7 +357,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -384,7 +384,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **overline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L119) +Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L120) #### Inherited from @@ -396,7 +396,7 @@ Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/ > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -410,7 +410,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **path**: [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L123) +Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L124) #### Inherited from @@ -422,7 +422,7 @@ Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/ > **pathAlign**: [`TPathAlign`](/api/type-aliases/tpathalign/) -Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L117) +Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L118) #### Inherited from @@ -434,7 +434,7 @@ Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/ > **pathSide**: [`TPathSide`](/api/type-aliases/tpathside/) -Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L116) +Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L117) #### Inherited from @@ -446,7 +446,7 @@ Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/ > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -466,7 +466,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -486,7 +486,7 @@ Object scale factor (vertical) > **selectionEnd**: `number` -Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L71) +Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L71) #### Inherited from @@ -498,7 +498,7 @@ Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js > **selectionStart**: `number` -Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L70) +Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L70) #### Inherited from @@ -510,7 +510,7 @@ Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js > **shadow**: `null` \| `Partial`\<[`SerializedShadowOptions`](/api/type-aliases/serializedshadowoptions/)\> -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L31) Shadow object representing shadow of this shape @@ -530,7 +530,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -550,7 +550,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -570,7 +570,7 @@ Angle of skew on y axes of an object (in degrees) > **splitByGrapheme**: `boolean` -Defined in: [src/shapes/Textbox.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L37) +Defined in: [src/shapes/Textbox.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L37) #### Inherited from @@ -582,7 +582,7 @@ Defined in: [src/shapes/Textbox.ts:37](https://github.com/fabricjs/fabric.js/blo > **stroke**: `null` \| `string` \| `Record`\<`string`, `any`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"linear"`\> \| [`SerializedGradientProps`](/api/type-aliases/serializedgradientprops/)\<`"radial"`\> -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L33) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L33) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -603,7 +603,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -623,7 +623,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -643,7 +643,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -663,7 +663,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -677,7 +677,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -697,7 +697,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -730,7 +730,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -750,7 +750,7 @@ Width of a stroke used to render this object > **styles**: [`TextStyle`](/api/type-aliases/textstyle/) \| [`TextStyleArray`](/api/fabric/namespaces/util/type-aliases/textstylearray/) -Defined in: [src/shapes/Text/Text.ts:129](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L129) +Defined in: [src/shapes/Text/Text.ts:131](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L131) #### Inherited from @@ -762,7 +762,7 @@ Defined in: [src/shapes/Text/Text.ts:129](https://github.com/fabricjs/fabric.js/ > **textAlign**: `TextAlign` -Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L121) +Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L122) #### Inherited from @@ -770,11 +770,23 @@ Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/ *** +### textDecorationColor? + +> `optional` **textDecorationColor**: `string` + +Defined in: [src/shapes/Text/Text.ts:126](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L126) + +#### Inherited from + +[`SerializedITextProps`](/api/interfaces/serializeditextprops/).[`textDecorationColor`](/api/interfaces/serializeditextprops/#textdecorationcolor) + +*** + ### textDecorationThickness > **textDecorationThickness**: `number` -Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L124) +Defined in: [src/shapes/Text/Text.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L125) #### Inherited from @@ -786,7 +798,7 @@ Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/ > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -808,7 +820,7 @@ You can change this by setting originY > **underline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L118) +Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L119) #### Inherited from @@ -820,7 +832,7 @@ Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/ > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -834,7 +846,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/StaticCanvasEvents.md b/src/content/docs/api/interfaces/StaticCanvasEvents.md index f8844709..a10d32cb 100644 --- a/src/content/docs/api/interfaces/StaticCanvasEvents.md +++ b/src/content/docs/api/interfaces/StaticCanvasEvents.md @@ -5,7 +5,7 @@ prev: false title: "StaticCanvasEvents" --- -Defined in: [src/EventTypeDefs.ts:311](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L311) +Defined in: [src/EventTypeDefs.ts:315](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L315) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/EventTypeDefs.ts:311](https://github.com/fabricjs/fabric.js/blo > **after:render**: `object` -Defined in: [src/EventTypeDefs.ts:317](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L317) +Defined in: [src/EventTypeDefs.ts:321](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L321) #### ctx @@ -33,7 +33,7 @@ Defined in: [src/EventTypeDefs.ts:317](https://github.com/fabricjs/fabric.js/blo > **before:render**: `object` -Defined in: [src/EventTypeDefs.ts:316](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L316) +Defined in: [src/EventTypeDefs.ts:320](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L320) #### ctx @@ -45,7 +45,7 @@ Defined in: [src/EventTypeDefs.ts:316](https://github.com/fabricjs/fabric.js/blo > **canvas:cleared**: `never` -Defined in: [src/EventTypeDefs.ts:313](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L313) +Defined in: [src/EventTypeDefs.ts:317](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L317) *** @@ -53,7 +53,7 @@ Defined in: [src/EventTypeDefs.ts:313](https://github.com/fabricjs/fabric.js/blo > **object:added**: `object` -Defined in: [src/EventTypeDefs.ts:240](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L240) +Defined in: [src/EventTypeDefs.ts:244](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L244) #### target @@ -69,7 +69,7 @@ Defined in: [src/EventTypeDefs.ts:240](https://github.com/fabricjs/fabric.js/blo > **object:layout:after**: [`LayoutAfterEvent`](/api/type-aliases/layoutafterevent/) & `object` -Defined in: [src/EventTypeDefs.ts:319](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L319) +Defined in: [src/EventTypeDefs.ts:323](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L323) #### Type Declaration @@ -83,7 +83,7 @@ Defined in: [src/EventTypeDefs.ts:319](https://github.com/fabricjs/fabric.js/blo > **object:layout:before**: [`LayoutBeforeEvent`](/api/type-aliases/layoutbeforeevent/) & `object` -Defined in: [src/EventTypeDefs.ts:318](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L318) +Defined in: [src/EventTypeDefs.ts:322](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L322) #### Type Declaration @@ -97,7 +97,7 @@ Defined in: [src/EventTypeDefs.ts:318](https://github.com/fabricjs/fabric.js/blo > **object:removed**: `object` -Defined in: [src/EventTypeDefs.ts:241](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L241) +Defined in: [src/EventTypeDefs.ts:245](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L245) #### target diff --git a/src/content/docs/api/interfaces/StaticCanvasOptions.md b/src/content/docs/api/interfaces/StaticCanvasOptions.md index 34f8124a..d1e877bd 100644 --- a/src/content/docs/api/interfaces/StaticCanvasOptions.md +++ b/src/content/docs/api/interfaces/StaticCanvasOptions.md @@ -5,7 +5,7 @@ prev: false title: "StaticCanvasOptions" --- -Defined in: [src/canvas/StaticCanvasOptions.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L115) +Defined in: [src/canvas/StaticCanvasOptions.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L115) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/canvas/StaticCanvasOptions.ts:115](https://github.com/fabricjs/ > **allowTouchScrolling**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L148) +Defined in: [src/canvas/StaticCanvasOptions.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L148) Indicates whether the browser can be scrolled when using a touchscreen and dragging on the canvas It gives PRIORITY to DOM scrolling, it doesn't make it always possible. @@ -38,7 +38,7 @@ move to Canvas > **backgroundColor**: `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/canvas/StaticCanvasOptions.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L18) +Defined in: [src/canvas/StaticCanvasOptions.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L18) Background color of canvas instance. @@ -52,7 +52,7 @@ Background color of canvas instance. > `optional` **backgroundImage**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvasOptions.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L27) +Defined in: [src/canvas/StaticCanvasOptions.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L27) Background image of canvas instance. since 2.4.0 image caching is active, please when putting an image as background, add to the @@ -69,7 +69,7 @@ vale. As an alternative you can disable image objectCaching > **backgroundVpt**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L12) +Defined in: [src/canvas/StaticCanvasOptions.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L12) if set to false background image is not affected by viewport transform @@ -91,7 +91,7 @@ we should really find a different way to do this > `optional` **clipPath**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvasOptions.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L96) +Defined in: [src/canvas/StaticCanvasOptions.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L96) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the canvas has rendered, and the context is placed in the @@ -108,7 +108,7 @@ clipPath will clip away controls, if you do not want this to happen use controls > **controlsAboveOverlay**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:137](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L137) +Defined in: [src/canvas/StaticCanvasOptions.ts:137](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L137) Indicates whether object controls (borders/controls) are rendered above overlay image @@ -122,7 +122,7 @@ move to Canvas > **enableRetinaScaling**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L81) +Defined in: [src/canvas/StaticCanvasOptions.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L81) When true, canvas is scaled by devicePixelRatio for better rendering on retina screens @@ -136,7 +136,7 @@ When true, canvas is scaled by devicePixelRatio for better rendering on retina s > **height**: `number` -Defined in: [src/canvas/StaticCanvasOptions.ts:129](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L129) +Defined in: [src/canvas/StaticCanvasOptions.ts:129](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L129) Height in virtual/logical pixels of the canvas. The canvas can be taller than width if retina scaling is active @@ -147,7 +147,7 @@ The canvas can be taller than width if retina scaling is active > **imageSmoothingEnabled**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L87) +Defined in: [src/canvas/StaticCanvasOptions.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L87) Indicates whether this canvas will use image smoothing, this is on by default in browsers @@ -161,7 +161,7 @@ Indicates whether this canvas will use image smoothing, this is on by default in > **includeDefaultValues**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L105) +Defined in: [src/canvas/StaticCanvasOptions.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L105) Indicates whether toObject/toDatalessObject should include default values if set to false, takes precedence over the object value. @@ -176,7 +176,7 @@ if set to false, takes precedence over the object value. > **overlayColor**: `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/canvas/StaticCanvasOptions.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L42) +Defined in: [src/canvas/StaticCanvasOptions.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L42) Overlay color of canvas instance. @@ -194,7 +194,7 @@ Overlay color of canvas instance. > `optional` **overlayImage**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/canvas/StaticCanvasOptions.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L51) +Defined in: [src/canvas/StaticCanvasOptions.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L51) Overlay image of canvas instance. since 2.4.0 image caching is active, please when putting an image as overlay, add to the @@ -211,7 +211,7 @@ vale. As an alternative you can disable image objectCaching > **overlayVpt**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L35) +Defined in: [src/canvas/StaticCanvasOptions.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L35) if set to false overlay image is not affected by viewport transform @@ -233,7 +233,7 @@ we should really find a different way to do this > **renderOnAddRemove**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L64) +Defined in: [src/canvas/StaticCanvasOptions.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L64) Indicates whether [StaticCanvas#add](/api/classes/staticcanvas/#add), [StaticCanvas#insertAt](/api/classes/staticcanvas/#insertat) and StaticCanvas#remove, StaticCanvas#moveTo, [StaticCanvas#clear](/api/classes/staticcanvas/#clear) and many more, should also re-render canvas. @@ -252,7 +252,7 @@ Left default to true to do not break documentation and old app, fiddles. > **skipOffscreen**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L75) +Defined in: [src/canvas/StaticCanvasOptions.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L75) Based on vptCoords and object.aCoords, skip rendering of objects that are not included in current viewport. @@ -276,7 +276,7 @@ true > **svgViewportTransformation**: `boolean` -Defined in: [src/canvas/StaticCanvasOptions.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L112) +Defined in: [src/canvas/StaticCanvasOptions.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L112) When true, getSvgTransform() will apply the StaticCanvas.viewportTransform to the SVG transformation. When true, a zoomed canvas will then produce zoomed SVG output. @@ -291,7 +291,7 @@ a zoomed canvas will then produce zoomed SVG output. > **viewportTransform**: [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/canvas/StaticCanvasOptions.ts:158](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L158) +Defined in: [src/canvas/StaticCanvasOptions.ts:158](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L158) The transformation (a Canvas 2D API transform matrix) which focuses the viewport @@ -311,7 +311,7 @@ canvas.viewportTransform = [0.7, 0, 0, 0.7, 50, 50]; > **width**: `number` -Defined in: [src/canvas/StaticCanvasOptions.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvasOptions.ts#L122) +Defined in: [src/canvas/StaticCanvasOptions.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvasOptions.ts#L122) Width in virtual/logical pixels of the canvas. The canvas can be larger than width if retina scaling is active diff --git a/src/content/docs/api/interfaces/TEvent.md b/src/content/docs/api/interfaces/TEvent.md index 1c9353f6..18386fcd 100644 --- a/src/content/docs/api/interfaces/TEvent.md +++ b/src/content/docs/api/interfaces/TEvent.md @@ -5,7 +5,7 @@ prev: false title: "TEvent" --- -Defined in: [src/EventTypeDefs.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L103) +Defined in: [src/EventTypeDefs.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L103) ## Extended by @@ -25,4 +25,4 @@ Defined in: [src/EventTypeDefs.ts:103](https://github.com/fabricjs/fabric.js/blo > **e**: `E` -Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L104) +Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L104) diff --git a/src/content/docs/api/interfaces/TPointerEventInfo.md b/src/content/docs/api/interfaces/TPointerEventInfo.md index 655f38d2..f78c12d9 100644 --- a/src/content/docs/api/interfaces/TPointerEventInfo.md +++ b/src/content/docs/api/interfaces/TPointerEventInfo.md @@ -5,7 +5,7 @@ prev: false title: "TPointerEventInfo" --- -Defined in: [src/EventTypeDefs.ts:167](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L167) +Defined in: [src/EventTypeDefs.ts:167](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L167) ## Extends @@ -23,7 +23,7 @@ Defined in: [src/EventTypeDefs.ts:167](https://github.com/fabricjs/fabric.js/blo > **e**: `E` -Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L104) +Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L104) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [src/EventTypeDefs.ts:104](https://github.com/fabricjs/fabric.js/blo > **scenePoint**: [`Point`](/api/classes/point/) -Defined in: [src/EventTypeDefs.ts:173](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L173) +Defined in: [src/EventTypeDefs.ts:173](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L173) *** @@ -43,7 +43,7 @@ Defined in: [src/EventTypeDefs.ts:173](https://github.com/fabricjs/fabric.js/blo > `optional` **subTargets**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\>[] -Defined in: [src/EventTypeDefs.ts:171](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L171) +Defined in: [src/EventTypeDefs.ts:171](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L171) *** @@ -51,7 +51,7 @@ Defined in: [src/EventTypeDefs.ts:171](https://github.com/fabricjs/fabric.js/blo > `optional` **target**: [`FabricObject`](/api/classes/fabricobject/)\<`Partial`\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/EventTypeDefs.ts:170](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L170) +Defined in: [src/EventTypeDefs.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L170) *** @@ -59,7 +59,7 @@ Defined in: [src/EventTypeDefs.ts:170](https://github.com/fabricjs/fabric.js/blo > `optional` **transform**: `null` \| [`Transform`](/api/type-aliases/transform/) -Defined in: [src/EventTypeDefs.ts:172](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L172) +Defined in: [src/EventTypeDefs.ts:172](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L172) *** @@ -67,4 +67,4 @@ Defined in: [src/EventTypeDefs.ts:172](https://github.com/fabricjs/fabric.js/blo > **viewportPoint**: [`Point`](/api/classes/point/) -Defined in: [src/EventTypeDefs.ts:174](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L174) +Defined in: [src/EventTypeDefs.ts:174](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L174) diff --git a/src/content/docs/api/interfaces/TextProps.md b/src/content/docs/api/interfaces/TextProps.md index 33952b30..f72215ea 100644 --- a/src/content/docs/api/interfaces/TextProps.md +++ b/src/content/docs/api/interfaces/TextProps.md @@ -5,7 +5,7 @@ prev: false title: "TextProps" --- -Defined in: [src/shapes/Text/Text.ts:132](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L132) +Defined in: [src/shapes/Text/Text.ts:134](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L134) ## Extends @@ -21,7 +21,7 @@ Defined in: [src/shapes/Text/Text.ts:132](https://github.com/fabricjs/fabric.js/ > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -46,7 +46,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -66,7 +66,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -81,7 +81,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -101,7 +101,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -119,7 +119,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -139,7 +139,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -163,7 +163,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -175,7 +175,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -197,7 +197,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -216,7 +216,7 @@ when being scaled via the controls. > **charSpacing**: `number` -Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L110) +Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L111) #### Inherited from @@ -228,7 +228,7 @@ Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/ > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -245,7 +245,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -265,7 +265,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -289,7 +289,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -309,7 +309,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -333,7 +333,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -363,7 +363,7 @@ This API is no longer supported and may be removed in a future release. > **direction**: `CanvasDirection` -Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L122) +Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L123) #### Inherited from @@ -375,7 +375,7 @@ Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/ > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -389,7 +389,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -407,7 +407,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -428,7 +428,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -450,7 +450,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -470,7 +470,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -490,7 +490,7 @@ false > **fontFamily**: `string` -Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L114) +Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L115) #### Inherited from @@ -502,7 +502,7 @@ Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/ > **fontSize**: `number` -Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L112) +Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L113) #### Inherited from @@ -514,7 +514,7 @@ Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/ > **fontStyle**: `FontStyle` -Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L115) +Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L116) #### Inherited from @@ -526,7 +526,7 @@ Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/ > **fontWeight**: `string` \| `number` -Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L113) +Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L114) #### Inherited from @@ -538,7 +538,7 @@ Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/ > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -552,7 +552,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -566,7 +566,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -586,7 +586,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -600,7 +600,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -620,7 +620,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -634,7 +634,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -656,7 +656,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -678,7 +678,7 @@ You can change this by setting originX > **lineHeight**: `number` -Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L111) +Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L112) #### Inherited from @@ -690,7 +690,7 @@ Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/ > **linethrough**: `boolean` -Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L120) +Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L121) #### Inherited from @@ -702,7 +702,7 @@ Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/ > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -716,7 +716,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -730,7 +730,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -744,7 +744,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -758,7 +758,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -772,7 +772,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -786,7 +786,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -800,7 +800,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -814,7 +814,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -834,7 +834,7 @@ Minimum allowed scale value of an object > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -854,11 +854,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -878,7 +878,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -904,7 +904,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -924,7 +924,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -951,7 +951,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -978,7 +978,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **overline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L119) +Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L120) #### Inherited from @@ -990,7 +990,7 @@ Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/ > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -1010,7 +1010,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1024,7 +1024,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **path**: [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L123) +Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L124) #### Inherited from @@ -1036,7 +1036,7 @@ Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/ > **pathAlign**: [`TPathAlign`](/api/type-aliases/tpathalign/) -Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L117) +Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L118) #### Inherited from @@ -1048,7 +1048,7 @@ Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/ > **pathSide**: [`TPathSide`](/api/type-aliases/tpathside/) -Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L116) +Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L117) #### Inherited from @@ -1060,7 +1060,7 @@ Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/ > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1074,7 +1074,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -1094,7 +1094,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -1114,7 +1114,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1129,7 +1129,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1148,7 +1148,7 @@ This API is no longer supported and may be removed in a future release. > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1168,7 +1168,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1188,7 +1188,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1208,7 +1208,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1222,7 +1222,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1237,7 +1237,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1258,7 +1258,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1278,7 +1278,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1298,7 +1298,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1318,7 +1318,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1332,7 +1332,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1352,7 +1352,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1385,7 +1385,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1405,7 +1405,7 @@ Width of a stroke used to render this object > **styles**: [`TextStyle`](/api/type-aliases/textstyle/) -Defined in: [src/shapes/Text/Text.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L133) +Defined in: [src/shapes/Text/Text.ts:135](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L135) *** @@ -1413,7 +1413,7 @@ Defined in: [src/shapes/Text/Text.ts:133](https://github.com/fabricjs/fabric.js/ > **textAlign**: `TextAlign` -Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L121) +Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L122) #### Inherited from @@ -1421,11 +1421,23 @@ Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/ *** +### textDecorationColor? + +> `optional` **textDecorationColor**: `string` + +Defined in: [src/shapes/Text/Text.ts:126](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L126) + +#### Inherited from + +`UniqueTextProps.textDecorationColor` + +*** + ### textDecorationThickness > **textDecorationThickness**: `number` -Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L124) +Defined in: [src/shapes/Text/Text.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L125) #### Inherited from @@ -1437,7 +1449,7 @@ Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/ > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1459,7 +1471,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1479,7 +1491,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1499,7 +1511,7 @@ true > **underline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L118) +Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L119) #### Inherited from @@ -1511,7 +1523,7 @@ Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/ > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1525,7 +1537,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/TextboxProps.md b/src/content/docs/api/interfaces/TextboxProps.md index 6fda906f..8414c690 100644 --- a/src/content/docs/api/interfaces/TextboxProps.md +++ b/src/content/docs/api/interfaces/TextboxProps.md @@ -5,7 +5,7 @@ prev: false title: "TextboxProps" --- -Defined in: [src/shapes/Textbox.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L47) +Defined in: [src/shapes/Textbox.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L47) ## Extends @@ -17,7 +17,7 @@ Defined in: [src/shapes/Textbox.ts:47](https://github.com/fabricjs/fabric.js/blo > **\_wordJoiners**: `RegExp` -Defined in: [src/shapes/Textbox.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L39) +Defined in: [src/shapes/Textbox.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L39) #### Inherited from @@ -29,7 +29,7 @@ Defined in: [src/shapes/Textbox.ts:39](https://github.com/fabricjs/fabric.js/blo > **absolutePositioned**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L69) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L69) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will @@ -54,7 +54,7 @@ false > **angle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L61) +Defined in: [src/shapes/Object/types/BaseProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L61) Angle of rotation of an object (in degrees) @@ -74,7 +74,7 @@ Angle of rotation of an object (in degrees) > **backgroundColor**: `string` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L24) Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/ @@ -89,7 +89,7 @@ takes css colors https://www.w3.org/TR/css-color-3/ > **borderColor**: `string` -Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L7) +Defined in: [src/shapes/Object/types/BorderProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L7) Color of controlling borders of an object (when it's active) @@ -109,7 +109,7 @@ rgb(178,204,255) > **borderDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L15) +Defined in: [src/shapes/Object/types/BorderProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L15) Array specifying dash pattern of an object's borders (hasBorder must be true) @@ -127,7 +127,7 @@ Array specifying dash pattern of an object's borders (hasBorder must be true) > **borderOpacityWhenMoving**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L28) +Defined in: [src/shapes/Object/types/BorderProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L28) Opacity of object's controlling borders when object is active and moving @@ -147,7 +147,7 @@ Opacity of object's controlling borders when object is active and moving > **borderScaleFactor**: `number` -Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L39) +Defined in: [src/shapes/Object/types/BorderProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L39) Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border @@ -171,7 +171,7 @@ you will need to write your own render function for controls > `optional` **canvas**: [`Canvas`](/api/classes/canvas/) \| [`StaticCanvas`](/api/classes/staticcanvas/)\<[`StaticCanvasEvents`](/api/interfaces/staticcanvasevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L18) +Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L18) #### Inherited from @@ -183,7 +183,7 @@ Defined in: [src/shapes/Object/types/ObjectProps.ts:18](https://github.com/fabri > **centeredRotation**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L26) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L26) When `true` the object will rotate on its center. When `false` will rotate around the origin point defined by originX and originY. @@ -205,7 +205,7 @@ The object method `rotate` will always consider this property and never the canv > **centeredScaling**: `boolean` -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L34) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L34) When true, this object will use center point as the origin of transformation when being scaled via the controls. @@ -224,7 +224,7 @@ when being scaled via the controls. > **charSpacing**: `number` -Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L110) +Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L111) #### Inherited from @@ -236,7 +236,7 @@ Defined in: [src/shapes/Text/Text.ts:110](https://github.com/fabricjs/fabric.js/ > `optional` **clipPath**: [`BaseFabricObject`](/api/classes/basefabricobject/)\<`Partial`\<`ObjectProps`\>, [`SerializedObjectProps`](/api/interfaces/serializedobjectprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L14) +Defined in: [src/shapes/Object/types/ObjectProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L14) a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center @@ -253,7 +253,7 @@ If you want 0,0 of a clipPath to align with an object center, use clipPath.origi > **cornerColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L28) +Defined in: [src/shapes/Object/types/ControlProps.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L28) Color of controlling corners of an object (when it's active) @@ -273,7 +273,7 @@ rgb(178,204,255) > **cornerDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L55) +Defined in: [src/shapes/Object/types/ControlProps.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L55) Array specifying dash pattern of an object's control (hasBorder must be true) @@ -297,7 +297,7 @@ null > **cornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L7) +Defined in: [src/shapes/Object/types/ControlProps.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L7) Size of object's controlling corners (in pixels) @@ -317,7 +317,7 @@ Size of object's controlling corners (in pixels) > **cornerStrokeColor**: `string` -Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L36) +Defined in: [src/shapes/Object/types/ControlProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L36) Color of controlling corners of an object (when it's active and transparentCorners false) @@ -341,7 +341,7 @@ Color of controlling corners of an object (when it's active and transparentCorne > **cornerStyle**: `"circle"` \| `"rect"` -Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L47) +Defined in: [src/shapes/Object/types/ControlProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L47) Specify style of control, 'rect' or 'circle' This is deprecated. In the future there will be a standard control render @@ -371,7 +371,7 @@ This API is no longer supported and may be removed in a future release. > **direction**: `CanvasDirection` -Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L122) +Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L123) #### Inherited from @@ -383,7 +383,7 @@ Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/ > **dynamicMinWidth**: `number` -Defined in: [src/shapes/Textbox.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L38) +Defined in: [src/shapes/Textbox.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L38) #### Inherited from @@ -395,7 +395,7 @@ Defined in: [src/shapes/Textbox.ts:38](https://github.com/fabricjs/fabric.js/blo > **evented**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L58) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L58) When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4 @@ -409,7 +409,7 @@ When set to `false`, an object can not be a target of events. All events propaga > **excludeFromExport**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L48) +Defined in: [src/shapes/Object/types/ObjectProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L48) When `true`, object is not exported in OBJECT/JSON @@ -427,7 +427,7 @@ When `true`, object is not exported in OBJECT/JSON > **fill**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L15) Color of object's fill takes css colors https://www.w3.org/TR/css-color-3/ @@ -448,7 +448,7 @@ rgb(0,0,0) > **fillRule**: `CanvasFillRule` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L25) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L25) Fill rule used to fill an object accepted values are nonzero, evenodd @@ -470,7 +470,7 @@ nonzero > **flipX**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L68) +Defined in: [src/shapes/Object/types/BaseProps.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L68) When true, an object is rendered as flipped horizontally @@ -490,7 +490,7 @@ false > **flipY**: `boolean` -Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L75) +Defined in: [src/shapes/Object/types/BaseProps.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L75) When true, an object is rendered as flipped vertically @@ -510,7 +510,7 @@ false > **fontFamily**: `string` -Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L114) +Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L115) #### Inherited from @@ -522,7 +522,7 @@ Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/ > **fontSize**: `number` -Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L112) +Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L113) #### Inherited from @@ -534,7 +534,7 @@ Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/ > **fontStyle**: `FontStyle` -Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L115) +Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L116) #### Inherited from @@ -546,7 +546,7 @@ Defined in: [src/shapes/Text/Text.ts:115](https://github.com/fabricjs/fabric.js/ > **fontWeight**: `string` \| `number` -Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L113) +Defined in: [src/shapes/Text/Text.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L114) #### Inherited from @@ -558,7 +558,7 @@ Defined in: [src/shapes/Text/Text.ts:113](https://github.com/fabricjs/fabric.js/ > **globalCompositeOperation**: `GlobalCompositeOperation` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L17) Composite rule used for canvas globalCompositeOperation @@ -572,7 +572,7 @@ Composite rule used for canvas globalCompositeOperation > **hasBorders**: `boolean` -Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BorderProps.ts#L21) +Defined in: [src/shapes/Object/types/BorderProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BorderProps.ts#L21) When set to `false`, object's controlling borders are not rendered @@ -586,7 +586,7 @@ When set to `false`, object's controlling borders are not rendered > **hasControls**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L69) +Defined in: [src/shapes/Object/types/ControlProps.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L69) When set to `false`, object's controls are not displayed and can not be used to manipulate object @@ -606,7 +606,7 @@ true > **height**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L32) +Defined in: [src/shapes/Object/types/BaseProps.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L32) Object height @@ -620,7 +620,7 @@ Object height > **hoverCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L24) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L24) Default cursor value used when hovering over this object on canvas @@ -640,7 +640,7 @@ null > **includeDefaultValues**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L41) +Defined in: [src/shapes/Object/types/ObjectProps.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L41) When `false`, default object's values are not included in its serialization @@ -654,7 +654,7 @@ When `false`, default object's values are not included in its serialization > **inverted**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L57) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L57) Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath @@ -676,7 +676,7 @@ false > **left**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L11) +Defined in: [src/shapes/Object/types/BaseProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L11) Left position of an object. Note that by default it's relative to object left. @@ -698,7 +698,7 @@ You can change this by setting originX > **lineHeight**: `number` -Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L111) +Defined in: [src/shapes/Text/Text.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L112) #### Inherited from @@ -710,7 +710,7 @@ Defined in: [src/shapes/Text/Text.ts:111](https://github.com/fabricjs/fabric.js/ > **linethrough**: `boolean` -Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L120) +Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L121) #### Inherited from @@ -722,7 +722,7 @@ Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/ > **lockMovementX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L6) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L6) When `true`, object horizontal movement is locked @@ -736,7 +736,7 @@ When `true`, object horizontal movement is locked > **lockMovementY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L12) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:12](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L12) When `true`, object vertical movement is locked @@ -750,7 +750,7 @@ When `true`, object vertical movement is locked > **lockRotation**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L18) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L18) When `true`, object rotation is locked @@ -764,7 +764,7 @@ When `true`, object rotation is locked > **lockScalingFlip**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L48) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:48](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L48) When `true`, object cannot be flipped by scaling into negative values @@ -778,7 +778,7 @@ When `true`, object cannot be flipped by scaling into negative values > **lockScalingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L24) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L24) When `true`, object horizontal scaling is locked @@ -792,7 +792,7 @@ When `true`, object horizontal scaling is locked > **lockScalingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L30) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L30) When `true`, object vertical scaling is locked @@ -806,7 +806,7 @@ When `true`, object vertical scaling is locked > **lockSkewingX**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L36) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L36) When `true`, object horizontal skewing is locked @@ -820,7 +820,7 @@ When `true`, object horizontal skewing is locked > **lockSkewingY**: `boolean` -Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/LockInteractionProps.ts#L42) +Defined in: [src/shapes/Object/types/LockInteractionProps.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/LockInteractionProps.ts#L42) When `true`, object vertical skewing is locked @@ -834,7 +834,7 @@ When `true`, object vertical skewing is locked > **minScaleLimit**: `number` -Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L25) +Defined in: [src/shapes/Object/types/ObjectProps.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L25) Minimum allowed scale value of an object @@ -854,7 +854,7 @@ Minimum allowed scale value of an object > **minWidth**: `number` -Defined in: [src/shapes/Textbox.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L36) +Defined in: [src/shapes/Textbox.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L36) #### Inherited from @@ -866,7 +866,7 @@ Defined in: [src/shapes/Textbox.ts:36](https://github.com/fabricjs/fabric.js/blo > **moveCursor**: `null` \| `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L31) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L31) Default cursor value used when moving this object on canvas @@ -886,11 +886,11 @@ null > `optional` **noScaleCache**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L17) When `true`, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. -this setting is performance and application dependant. +this setting is performance and application dependent. default to true since 1.7.0 @@ -910,7 +910,7 @@ true > **objectCaching**: `boolean` -Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L35) +Defined in: [src/shapes/Object/types/ObjectProps.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L35) When `true`, object is cached on an additional canvas. When `false`, object is not cached unless necessary ( clipPath ) @@ -936,7 +936,7 @@ true > **opacity**: `number` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L11) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L11) Opacity of an object @@ -956,7 +956,7 @@ Opacity of an object > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L43) +Defined in: [src/shapes/Object/types/BaseProps.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L43) Horizontal origin of transformation of an object (`left`, `center`, `right` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -983,7 +983,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L54) +Defined in: [src/shapes/Object/types/BaseProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L54) Vertical origin of transformation of an object (`top`, `center`, `bottom` or `[0, 1]`) See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups @@ -1010,7 +1010,7 @@ To set the default value to 'center' import BaseFabricObject and set the static > **overline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L119) +Defined in: [src/shapes/Text/Text.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L120) #### Inherited from @@ -1022,7 +1022,7 @@ Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/ > **padding**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L62) +Defined in: [src/shapes/Object/types/ControlProps.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L62) Padding between object and its controlling borders (in pixels) @@ -1042,7 +1042,7 @@ Padding between object and its controlling borders (in pixels) > **paintFirst**: `"fill"` \| `"stroke"` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L8) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L8) Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") @@ -1056,7 +1056,7 @@ Determines if the fill or the stroke is drawn first (one of "fill" or "stroke") > `optional` **path**: [`Path`](/api/classes/path/)\<`Partial`\<[`PathProps`](/api/interfaces/pathprops/)\>, [`SerializedPathProps`](/api/interfaces/serializedpathprops/), [`ObjectEvents`](/api/interfaces/objectevents/)\> -Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L123) +Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L124) #### Inherited from @@ -1068,7 +1068,7 @@ Defined in: [src/shapes/Text/Text.ts:123](https://github.com/fabricjs/fabric.js/ > **pathAlign**: [`TPathAlign`](/api/type-aliases/tpathalign/) -Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L117) +Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L118) #### Inherited from @@ -1080,7 +1080,7 @@ Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/ > **pathSide**: [`TPathSide`](/api/type-aliases/tpathside/) -Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L116) +Defined in: [src/shapes/Text/Text.ts:117](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L117) #### Inherited from @@ -1092,7 +1092,7 @@ Defined in: [src/shapes/Text/Text.ts:116](https://github.com/fabricjs/fabric.js/ > **perPixelTargetFind**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L45) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L45) When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box @@ -1106,7 +1106,7 @@ When set to `true`, objects are "found" on canvas on per-pixel basis rather than > **scaleX**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L82) +Defined in: [src/shapes/Object/types/BaseProps.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L82) Object scale factor (horizontal) @@ -1126,7 +1126,7 @@ Object scale factor (horizontal) > **scaleY**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L89) +Defined in: [src/shapes/Object/types/BaseProps.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L89) Object scale factor (vertical) @@ -1146,7 +1146,7 @@ Object scale factor (vertical) > **selectable**: `boolean` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L52) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L52) When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it. @@ -1161,7 +1161,7 @@ But events still fire on it. > **selectionBackgroundColor**: `string` -Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FabricObjectProps.ts#L39) +Defined in: [src/shapes/Object/types/FabricObjectProps.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FabricObjectProps.ts#L39) Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods. @@ -1180,7 +1180,7 @@ This API is no longer supported and may be removed in a future release. > **selectionEnd**: `number` -Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L71) +Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L71) #### Inherited from @@ -1192,7 +1192,7 @@ Defined in: [src/shapes/IText/IText.ts:71](https://github.com/fabricjs/fabric.js > **selectionStart**: `number` -Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L70) +Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L70) #### Inherited from @@ -1204,7 +1204,7 @@ Defined in: [src/shapes/IText/IText.ts:70](https://github.com/fabricjs/fabric.js > **shadow**: `null` \| [`Shadow`](/api/classes/shadow/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L17) +Defined in: [src/shapes/Object/types/ObjectProps.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L17) Shadow object representing shadow of this shape @@ -1224,7 +1224,7 @@ null > **skewX**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L96) +Defined in: [src/shapes/Object/types/BaseProps.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L96) Angle of skew on x axes of an object (in degrees) @@ -1244,7 +1244,7 @@ Angle of skew on x axes of an object (in degrees) > **skewY**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L103) +Defined in: [src/shapes/Object/types/BaseProps.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L103) Angle of skew on y axes of an object (in degrees) @@ -1264,7 +1264,7 @@ Angle of skew on y axes of an object (in degrees) > `optional` **snapAngle**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L8) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L8) The angle that an object will lock to while rotating. @@ -1278,7 +1278,7 @@ The angle that an object will lock to while rotating. > `optional` **snapThreshold**: [`TDegree`](/api/type-aliases/tdegree/) -Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectTransformProps.ts#L15) +Defined in: [src/shapes/Object/types/ObjectTransformProps.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectTransformProps.ts#L15) The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle. @@ -1293,7 +1293,7 @@ When undefined, the snapThreshold will default to the snapAngle. > **splitByGrapheme**: `boolean` -Defined in: [src/shapes/Textbox.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L37) +Defined in: [src/shapes/Textbox.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L37) #### Inherited from @@ -1305,7 +1305,7 @@ Defined in: [src/shapes/Textbox.ts:37](https://github.com/fabricjs/fabric.js/blo > **stroke**: `null` \| `string` \| [`TFiller`](/api/type-aliases/tfiller/) -Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ObjectProps.ts#L16) +Defined in: [src/shapes/Object/types/ObjectProps.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ObjectProps.ts#L16) When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/ @@ -1326,7 +1326,7 @@ null > **strokeDashArray**: `null` \| `number`[] -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L47) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L47) Array specifying dash pattern of an object's stroke (stroke must be defined) @@ -1346,7 +1346,7 @@ null; > **strokeDashOffset**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L54) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L54) Line offset of an object's stroke @@ -1366,7 +1366,7 @@ Line offset of an object's stroke > **strokeLineCap**: `CanvasLineCap` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L61) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L61) Line endings style of an object's stroke (one of "butt", "round", "square") @@ -1386,7 +1386,7 @@ butt > **strokeLineJoin**: `CanvasLineJoin` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L67) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L67) Corner style of an object's stroke (one of "bevel", "round", "miter") @@ -1400,7 +1400,7 @@ Corner style of an object's stroke (one of "bevel", "round", "miter") > **strokeMiterLimit**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L74) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L74) Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke @@ -1420,7 +1420,7 @@ Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke > **strokeUniform**: `boolean` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L87) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L87) When `false`, the stoke width will scale with the object. When `true`, the stroke will always match the exact pixel size entered for stroke width. @@ -1453,7 +1453,7 @@ false > **strokeWidth**: `number` -Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/FillStrokeProps.ts#L40) +Defined in: [src/shapes/Object/types/FillStrokeProps.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/FillStrokeProps.ts#L40) Width of a stroke used to render this object @@ -1473,7 +1473,7 @@ Width of a stroke used to render this object > **styles**: [`TextStyle`](/api/type-aliases/textstyle/) -Defined in: [src/shapes/Text/Text.ts:133](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L133) +Defined in: [src/shapes/Text/Text.ts:135](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L135) #### Inherited from @@ -1485,7 +1485,7 @@ Defined in: [src/shapes/Text/Text.ts:133](https://github.com/fabricjs/fabric.js/ > **textAlign**: `TextAlign` -Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L121) +Defined in: [src/shapes/Text/Text.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L122) #### Inherited from @@ -1493,11 +1493,23 @@ Defined in: [src/shapes/Text/Text.ts:121](https://github.com/fabricjs/fabric.js/ *** +### textDecorationColor? + +> `optional` **textDecorationColor**: `string` + +Defined in: [src/shapes/Text/Text.ts:126](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L126) + +#### Inherited from + +[`ITextProps`](/api/interfaces/itextprops/).[`textDecorationColor`](/api/interfaces/itextprops/#textdecorationcolor) + +*** + ### textDecorationThickness > **textDecorationThickness**: `number` -Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L124) +Defined in: [src/shapes/Text/Text.ts:125](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L125) #### Inherited from @@ -1509,7 +1521,7 @@ Defined in: [src/shapes/Text/Text.ts:124](https://github.com/fabricjs/fabric.js/ > **top**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L20) +Defined in: [src/shapes/Object/types/BaseProps.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L20) Top position of an object. Note that by default it's relative to object top. @@ -1531,7 +1543,7 @@ You can change this by setting originY > **touchCornerSize**: `number` -Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L14) +Defined in: [src/shapes/Object/types/ControlProps.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L14) Size of object's controlling corners when touch interaction is detected @@ -1551,7 +1563,7 @@ Size of object's controlling corners when touch interaction is detected > **transparentCorners**: `boolean` -Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/ControlProps.ts#L21) +Defined in: [src/shapes/Object/types/ControlProps.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/ControlProps.ts#L21) When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill) @@ -1571,7 +1583,7 @@ true > **underline**: `boolean` -Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L118) +Defined in: [src/shapes/Text/Text.ts:119](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L119) #### Inherited from @@ -1583,7 +1595,7 @@ Defined in: [src/shapes/Text/Text.ts:118](https://github.com/fabricjs/fabric.js/ > **visible**: `boolean` -Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/SerializedObjectProps.ts#L37) +Defined in: [src/shapes/Object/types/SerializedObjectProps.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/SerializedObjectProps.ts#L37) When set to `false`, an object is not rendered on canvas @@ -1597,7 +1609,7 @@ When set to `false`, an object is not rendered on canvas > **width**: `number` -Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/BaseProps.ts#L26) +Defined in: [src/shapes/Object/types/BaseProps.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/BaseProps.ts#L26) Object width diff --git a/src/content/docs/api/interfaces/XY.md b/src/content/docs/api/interfaces/XY.md index 68537eb8..2bb39802 100644 --- a/src/content/docs/api/interfaces/XY.md +++ b/src/content/docs/api/interfaces/XY.md @@ -5,7 +5,7 @@ prev: false title: "XY" --- -Defined in: [src/Point.ts:5](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L5) +Defined in: [src/Point.ts:5](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L5) ## Properties @@ -13,7 +13,7 @@ Defined in: [src/Point.ts:5](https://github.com/fabricjs/fabric.js/blob/22fda457 > **x**: `number` -Defined in: [src/Point.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L6) +Defined in: [src/Point.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L6) *** @@ -21,4 +21,4 @@ Defined in: [src/Point.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda457 > **y**: `number` -Defined in: [src/Point.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Point.ts#L7) +Defined in: [src/Point.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Point.ts#L7) diff --git a/src/content/docs/api/type-aliases/Abortable.md b/src/content/docs/api/type-aliases/Abortable.md index 83c1e943..56762f7d 100644 --- a/src/content/docs/api/type-aliases/Abortable.md +++ b/src/content/docs/api/type-aliases/Abortable.md @@ -7,7 +7,7 @@ title: "Abortable" > **Abortable** = `object` -Defined in: [src/typedefs.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L124) +Defined in: [src/typedefs.ts:124](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L124) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/typedefs.ts:124](https://github.com/fabricjs/fabric.js/blob/22f > `optional` **signal**: `AbortSignal` -Defined in: [src/typedefs.ts:129](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L129) +Defined in: [src/typedefs.ts:129](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L129) handle aborting diff --git a/src/content/docs/api/type-aliases/CanvasPointerEvents.md b/src/content/docs/api/type-aliases/CanvasPointerEvents.md index 85ac6835..afee3394 100644 --- a/src/content/docs/api/type-aliases/CanvasPointerEvents.md +++ b/src/content/docs/api/type-aliases/CanvasPointerEvents.md @@ -7,4 +7,4 @@ title: "CanvasPointerEvents" > **CanvasPointerEvents** = `TPointerEvents`\<`"mouse:"`\> -Defined in: [src/EventTypeDefs.ts:286](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L286) +Defined in: [src/EventTypeDefs.ts:290](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L290) diff --git a/src/content/docs/api/type-aliases/CircleBrushPoint.md b/src/content/docs/api/type-aliases/CircleBrushPoint.md index da97cab8..53e2194f 100644 --- a/src/content/docs/api/type-aliases/CircleBrushPoint.md +++ b/src/content/docs/api/type-aliases/CircleBrushPoint.md @@ -7,7 +7,7 @@ title: "CircleBrushPoint" > **CircleBrushPoint** = `object` -Defined in: [src/brushes/typedefs.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L6) +Defined in: [src/brushes/typedefs.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L6) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/brushes/typedefs.ts:6](https://github.com/fabricjs/fabric.js/bl > **fill**: `string` -Defined in: [src/brushes/typedefs.ts:10](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L10) +Defined in: [src/brushes/typedefs.ts:10](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L10) *** @@ -23,7 +23,7 @@ Defined in: [src/brushes/typedefs.ts:10](https://github.com/fabricjs/fabric.js/b > **radius**: `number` -Defined in: [src/brushes/typedefs.ts:9](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L9) +Defined in: [src/brushes/typedefs.ts:9](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L9) *** @@ -31,7 +31,7 @@ Defined in: [src/brushes/typedefs.ts:9](https://github.com/fabricjs/fabric.js/bl > **x**: `number` -Defined in: [src/brushes/typedefs.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L7) +Defined in: [src/brushes/typedefs.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L7) *** @@ -39,4 +39,4 @@ Defined in: [src/brushes/typedefs.ts:7](https://github.com/fabricjs/fabric.js/bl > **y**: `number` -Defined in: [src/brushes/typedefs.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L8) +Defined in: [src/brushes/typedefs.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L8) diff --git a/src/content/docs/api/type-aliases/CollectionChangeLayoutContext.md b/src/content/docs/api/type-aliases/CollectionChangeLayoutContext.md index bcbf3a16..65bceab9 100644 --- a/src/content/docs/api/type-aliases/CollectionChangeLayoutContext.md +++ b/src/content/docs/api/type-aliases/CollectionChangeLayoutContext.md @@ -7,7 +7,7 @@ title: "CollectionChangeLayoutContext" > **CollectionChangeLayoutContext** = [`CommonLayoutContext`](/api/type-aliases/commonlayoutcontext/) & `object` -Defined in: [src/LayoutManager/types.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L91) +Defined in: [src/LayoutManager/types.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L91) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/ColorStop.md b/src/content/docs/api/type-aliases/ColorStop.md index d556381c..f69f1be4 100644 --- a/src/content/docs/api/type-aliases/ColorStop.md +++ b/src/content/docs/api/type-aliases/ColorStop.md @@ -7,7 +7,7 @@ title: "ColorStop" > **ColorStop** = `object` -Defined in: [src/gradient/typedefs.ts:9](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L9) +Defined in: [src/gradient/typedefs.ts:9](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L9) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/gradient/typedefs.ts:9](https://github.com/fabricjs/fabric.js/b > **color**: `string` -Defined in: [src/gradient/typedefs.ts:10](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L10) +Defined in: [src/gradient/typedefs.ts:10](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L10) *** @@ -23,4 +23,4 @@ Defined in: [src/gradient/typedefs.ts:10](https://github.com/fabricjs/fabric.js/ > **offset**: `number` -Defined in: [src/gradient/typedefs.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L11) +Defined in: [src/gradient/typedefs.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L11) diff --git a/src/content/docs/api/type-aliases/CommonLayoutContext.md b/src/content/docs/api/type-aliases/CommonLayoutContext.md index 8a8b862b..7d570c09 100644 --- a/src/content/docs/api/type-aliases/CommonLayoutContext.md +++ b/src/content/docs/api/type-aliases/CommonLayoutContext.md @@ -7,7 +7,7 @@ title: "CommonLayoutContext" > **CommonLayoutContext** = `object` -Defined in: [src/LayoutManager/types.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L74) +Defined in: [src/LayoutManager/types.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L74) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/LayoutManager/types.ts:74](https://github.com/fabricjs/fabric.j > `optional` **path**: [`Group`](/api/classes/group/)[] -Defined in: [src/LayoutManager/types.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L81) +Defined in: [src/LayoutManager/types.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L81) array of objects starting from the object that triggered the call to the current one @@ -25,7 +25,7 @@ array of objects starting from the object that triggered the call to the current > `optional` **strategy**: [`LayoutStrategy`](/api/classes/layoutstrategy/) -Defined in: [src/LayoutManager/types.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L76) +Defined in: [src/LayoutManager/types.ts:76](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L76) *** @@ -33,7 +33,7 @@ Defined in: [src/LayoutManager/types.ts:76](https://github.com/fabricjs/fabric.j > **target**: [`Group`](/api/classes/group/) -Defined in: [src/LayoutManager/types.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L75) +Defined in: [src/LayoutManager/types.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L75) *** @@ -41,4 +41,4 @@ Defined in: [src/LayoutManager/types.ts:75](https://github.com/fabricjs/fabric.j > **type**: [`LayoutTrigger`](/api/type-aliases/layouttrigger/) -Defined in: [src/LayoutManager/types.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L77) +Defined in: [src/LayoutManager/types.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L77) diff --git a/src/content/docs/api/type-aliases/CompleteTextStyleDeclaration.md b/src/content/docs/api/type-aliases/CompleteTextStyleDeclaration.md index ed12faf8..15004fb9 100644 --- a/src/content/docs/api/type-aliases/CompleteTextStyleDeclaration.md +++ b/src/content/docs/api/type-aliases/CompleteTextStyleDeclaration.md @@ -7,4 +7,4 @@ title: "CompleteTextStyleDeclaration" > **CompleteTextStyleDeclaration** = `Pick`\<[`FabricText`](/api/classes/fabrictext/), `StylePropertiesType`\> -Defined in: [src/shapes/Text/StyledText.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L11) +Defined in: [src/shapes/Text/StyledText.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L11) diff --git a/src/content/docs/api/type-aliases/Constructor.md b/src/content/docs/api/type-aliases/Constructor.md index 19196369..5d2b517d 100644 --- a/src/content/docs/api/type-aliases/Constructor.md +++ b/src/content/docs/api/type-aliases/Constructor.md @@ -7,7 +7,7 @@ title: "Constructor" > **Constructor**\<`T`\> = (...`args`) => `T` -Defined in: [src/typedefs.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L20) +Defined in: [src/typedefs.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L20) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/ControlActionHandler.md b/src/content/docs/api/type-aliases/ControlActionHandler.md index bb105b5c..9c34f4b4 100644 --- a/src/content/docs/api/type-aliases/ControlActionHandler.md +++ b/src/content/docs/api/type-aliases/ControlActionHandler.md @@ -7,7 +7,7 @@ title: "ControlActionHandler" > **ControlActionHandler** = [`TransformAction`](/api/type-aliases/transformaction/)\<[`Transform`](/api/type-aliases/transform/), `any`\> -Defined in: [src/EventTypeDefs.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L53) +Defined in: [src/EventTypeDefs.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L53) Control handlers that run on control click/down/up Those handlers run with or without a transform defined diff --git a/src/content/docs/api/type-aliases/ControlCallback.md b/src/content/docs/api/type-aliases/ControlCallback.md index b444052e..a15f7e0a 100644 --- a/src/content/docs/api/type-aliases/ControlCallback.md +++ b/src/content/docs/api/type-aliases/ControlCallback.md @@ -7,7 +7,7 @@ title: "ControlCallback" > **ControlCallback**\<`R`\> = (`eventData`, `control`, `fabricObject`) => `R` -Defined in: [src/EventTypeDefs.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L55) +Defined in: [src/EventTypeDefs.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L55) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/ControlCursorCallback.md b/src/content/docs/api/type-aliases/ControlCursorCallback.md index 5dbb0852..41644031 100644 --- a/src/content/docs/api/type-aliases/ControlCursorCallback.md +++ b/src/content/docs/api/type-aliases/ControlCursorCallback.md @@ -7,7 +7,7 @@ title: "ControlCursorCallback" > **ControlCursorCallback**\<`R`\> = (`eventData`, `control`, `fabricObject`, `coord`) => `R` -Defined in: [src/EventTypeDefs.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L61) +Defined in: [src/EventTypeDefs.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L61) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/ControlRenderingStyleOverride.md b/src/content/docs/api/type-aliases/ControlRenderingStyleOverride.md new file mode 100644 index 00000000..954782d8 --- /dev/null +++ b/src/content/docs/api/type-aliases/ControlRenderingStyleOverride.md @@ -0,0 +1,10 @@ +--- +editUrl: false +next: false +prev: false +title: "ControlRenderingStyleOverride" +--- + +> **ControlRenderingStyleOverride** = `Partial`\<`Pick`\<[`InteractiveFabricObject`](/api/classes/interactivefabricobject/), `"cornerStyle"` \| `"cornerSize"` \| `"cornerColor"` \| `"cornerStrokeColor"` \| `"cornerDashArray"` \| `"transparentCorners"`\>\> + +Defined in: [src/controls/controlRendering.ts:5](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/controls/controlRendering.ts#L5) diff --git a/src/content/docs/api/type-aliases/CursorBoundaries.md b/src/content/docs/api/type-aliases/CursorBoundaries.md index 06247af4..1f04e9eb 100644 --- a/src/content/docs/api/type-aliases/CursorBoundaries.md +++ b/src/content/docs/api/type-aliases/CursorBoundaries.md @@ -7,7 +7,7 @@ title: "CursorBoundaries" > **CursorBoundaries** = `object` -Defined in: [src/shapes/IText/IText.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L25) +Defined in: [src/shapes/IText/IText.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L25) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/shapes/IText/IText.ts:25](https://github.com/fabricjs/fabric.js > **left**: `number` -Defined in: [src/shapes/IText/IText.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L26) +Defined in: [src/shapes/IText/IText.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L26) *** @@ -23,7 +23,7 @@ Defined in: [src/shapes/IText/IText.ts:26](https://github.com/fabricjs/fabric.js > **leftOffset**: `number` -Defined in: [src/shapes/IText/IText.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L28) +Defined in: [src/shapes/IText/IText.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L28) *** @@ -31,7 +31,7 @@ Defined in: [src/shapes/IText/IText.ts:28](https://github.com/fabricjs/fabric.js > **top**: `number` -Defined in: [src/shapes/IText/IText.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L27) +Defined in: [src/shapes/IText/IText.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L27) *** @@ -39,4 +39,4 @@ Defined in: [src/shapes/IText/IText.ts:27](https://github.com/fabricjs/fabric.js > **topOffset**: `number` -Defined in: [src/shapes/IText/IText.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L29) +Defined in: [src/shapes/IText/IText.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L29) diff --git a/src/content/docs/api/type-aliases/CursorRenderingData.md b/src/content/docs/api/type-aliases/CursorRenderingData.md index 07a897c9..86fd5efa 100644 --- a/src/content/docs/api/type-aliases/CursorRenderingData.md +++ b/src/content/docs/api/type-aliases/CursorRenderingData.md @@ -7,7 +7,7 @@ title: "CursorRenderingData" > **CursorRenderingData** = `object` -Defined in: [src/shapes/IText/IText.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L32) +Defined in: [src/shapes/IText/IText.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L32) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/shapes/IText/IText.ts:32](https://github.com/fabricjs/fabric.js > **color**: `string` -Defined in: [src/shapes/IText/IText.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L33) +Defined in: [src/shapes/IText/IText.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L33) *** @@ -23,7 +23,7 @@ Defined in: [src/shapes/IText/IText.ts:33](https://github.com/fabricjs/fabric.js > **height**: `number` -Defined in: [src/shapes/IText/IText.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L38) +Defined in: [src/shapes/IText/IText.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L38) *** @@ -31,7 +31,7 @@ Defined in: [src/shapes/IText/IText.ts:38](https://github.com/fabricjs/fabric.js > **left**: `number` -Defined in: [src/shapes/IText/IText.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L35) +Defined in: [src/shapes/IText/IText.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L35) *** @@ -39,7 +39,7 @@ Defined in: [src/shapes/IText/IText.ts:35](https://github.com/fabricjs/fabric.js > **opacity**: `number` -Defined in: [src/shapes/IText/IText.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L34) +Defined in: [src/shapes/IText/IText.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L34) *** @@ -47,7 +47,7 @@ Defined in: [src/shapes/IText/IText.ts:34](https://github.com/fabricjs/fabric.js > **top**: `number` -Defined in: [src/shapes/IText/IText.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L36) +Defined in: [src/shapes/IText/IText.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L36) *** @@ -55,4 +55,4 @@ Defined in: [src/shapes/IText/IText.ts:36](https://github.com/fabricjs/fabric.js > **width**: `number` -Defined in: [src/shapes/IText/IText.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/IText.ts#L37) +Defined in: [src/shapes/IText/IText.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/IText.ts#L37) diff --git a/src/content/docs/api/type-aliases/DrawContext.md b/src/content/docs/api/type-aliases/DrawContext.md index 872d3c3c..dc76d373 100644 --- a/src/content/docs/api/type-aliases/DrawContext.md +++ b/src/content/docs/api/type-aliases/DrawContext.md @@ -7,6 +7,6 @@ title: "DrawContext" > **DrawContext** = \{ `cacheTranslationX`: `number`; `cacheTranslationY`: `number`; `height`: `number`; `parentClipPaths`: [`BaseFabricObject`](/api/classes/basefabricobject/)[]; `width`: `number`; `zoomX`: `number`; `zoomY`: `number`; \} \| `Record`\<`string`, `never`\> -Defined in: [src/shapes/Object/Object.ts:138](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/Object.ts#L138) +Defined in: [src/shapes/Object/Object.ts:138](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/Object.ts#L138) Exported so we can tweak default values diff --git a/src/content/docs/api/type-aliases/GradientCoordValue.md b/src/content/docs/api/type-aliases/GradientCoordValue.md index 7c60fe9c..93d49b23 100644 --- a/src/content/docs/api/type-aliases/GradientCoordValue.md +++ b/src/content/docs/api/type-aliases/GradientCoordValue.md @@ -7,4 +7,4 @@ title: "GradientCoordValue" > **GradientCoordValue** = `number` \| [`Percent`](/api/type-aliases/percent/) \| `string` -Defined in: [src/gradient/typedefs.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L7) +Defined in: [src/gradient/typedefs.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L7) diff --git a/src/content/docs/api/type-aliases/GradientCoords.md b/src/content/docs/api/type-aliases/GradientCoords.md index a049d8b8..59c835ae 100644 --- a/src/content/docs/api/type-aliases/GradientCoords.md +++ b/src/content/docs/api/type-aliases/GradientCoords.md @@ -7,7 +7,7 @@ title: "GradientCoords" > **GradientCoords**\<`T`\> = `T` *extends* `"linear"` ? [`LinearGradientCoords`](/api/type-aliases/lineargradientcoords/)\<`number`\> : [`RadialGradientCoords`](/api/type-aliases/radialgradientcoords/)\<`number`\> -Defined in: [src/gradient/typedefs.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L60) +Defined in: [src/gradient/typedefs.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L60) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/GradientOptions.md b/src/content/docs/api/type-aliases/GradientOptions.md index 125fdbb0..f7e54f94 100644 --- a/src/content/docs/api/type-aliases/GradientOptions.md +++ b/src/content/docs/api/type-aliases/GradientOptions.md @@ -7,7 +7,7 @@ title: "GradientOptions" > **GradientOptions**\<`T`\> = `object` -Defined in: [src/gradient/typedefs.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L64) +Defined in: [src/gradient/typedefs.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L64) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [src/gradient/typedefs.ts:64](https://github.com/fabricjs/fabric.js/ > `optional` **colorStops**: [`ColorStop`](/api/type-aliases/colorstop/)[] -Defined in: [src/gradient/typedefs.ts:67](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L67) +Defined in: [src/gradient/typedefs.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L67) *** @@ -29,7 +29,7 @@ Defined in: [src/gradient/typedefs.ts:67](https://github.com/fabricjs/fabric.js/ > `optional` **coords**: `Partial`\<[`GradientCoords`](/api/type-aliases/gradientcoords/)\<`T`\>\> -Defined in: [src/gradient/typedefs.ts:68](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L68) +Defined in: [src/gradient/typedefs.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L68) *** @@ -37,7 +37,7 @@ Defined in: [src/gradient/typedefs.ts:68](https://github.com/fabricjs/fabric.js/ > `optional` **gradientTransform**: [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/gradient/typedefs.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L72) +Defined in: [src/gradient/typedefs.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L72) #### Todo @@ -49,7 +49,7 @@ rename? > `optional` **gradientUnits**: [`GradientUnits`](/api/type-aliases/gradientunits/) -Defined in: [src/gradient/typedefs.ts:66](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L66) +Defined in: [src/gradient/typedefs.ts:66](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L66) *** @@ -57,7 +57,7 @@ Defined in: [src/gradient/typedefs.ts:66](https://github.com/fabricjs/fabric.js/ > `optional` **id**: `string` -Defined in: [src/gradient/typedefs.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L73) +Defined in: [src/gradient/typedefs.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L73) *** @@ -65,7 +65,7 @@ Defined in: [src/gradient/typedefs.ts:73](https://github.com/fabricjs/fabric.js/ > `optional` **offsetX**: `number` -Defined in: [src/gradient/typedefs.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L77) +Defined in: [src/gradient/typedefs.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L77) SVG import compatibility @@ -75,7 +75,7 @@ SVG import compatibility > `optional` **offsetY**: `number` -Defined in: [src/gradient/typedefs.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L81) +Defined in: [src/gradient/typedefs.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L81) SVG import compatibility @@ -85,4 +85,4 @@ SVG import compatibility > `optional` **type**: `T` -Defined in: [src/gradient/typedefs.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L65) +Defined in: [src/gradient/typedefs.ts:65](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L65) diff --git a/src/content/docs/api/type-aliases/GradientType.md b/src/content/docs/api/type-aliases/GradientType.md index 7bd69d42..4f72becb 100644 --- a/src/content/docs/api/type-aliases/GradientType.md +++ b/src/content/docs/api/type-aliases/GradientType.md @@ -7,4 +7,4 @@ title: "GradientType" > **GradientType** = `"linear"` \| `"radial"` -Defined in: [src/gradient/typedefs.ts:5](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L5) +Defined in: [src/gradient/typedefs.ts:5](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L5) diff --git a/src/content/docs/api/type-aliases/GradientUnits.md b/src/content/docs/api/type-aliases/GradientUnits.md index fb2da1d9..5985b201 100644 --- a/src/content/docs/api/type-aliases/GradientUnits.md +++ b/src/content/docs/api/type-aliases/GradientUnits.md @@ -7,4 +7,4 @@ title: "GradientUnits" > **GradientUnits** = `"pixels"` \| `"percentage"` -Defined in: [src/gradient/typedefs.ts:3](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L3) +Defined in: [src/gradient/typedefs.ts:3](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L3) diff --git a/src/content/docs/api/type-aliases/GraphemeBBox.md b/src/content/docs/api/type-aliases/GraphemeBBox.md index 1d50a270..a56ded12 100644 --- a/src/content/docs/api/type-aliases/GraphemeBBox.md +++ b/src/content/docs/api/type-aliases/GraphemeBBox.md @@ -7,7 +7,7 @@ title: "GraphemeBBox" > **GraphemeBBox** = `object` -Defined in: [src/shapes/Text/Text.ts:97](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L97) +Defined in: [src/shapes/Text/Text.ts:98](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L98) Measure and return the info of a single grapheme. needs the the info of previous graphemes already filled @@ -19,7 +19,7 @@ Override to customize measuring > `optional` **angle**: `number` -Defined in: [src/shapes/Text/Text.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L105) +Defined in: [src/shapes/Text/Text.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L106) *** @@ -27,7 +27,7 @@ Defined in: [src/shapes/Text/Text.ts:105](https://github.com/fabricjs/fabric.js/ > **deltaY**: `number` -Defined in: [src/shapes/Text/Text.ts:102](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L102) +Defined in: [src/shapes/Text/Text.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L103) *** @@ -35,7 +35,7 @@ Defined in: [src/shapes/Text/Text.ts:102](https://github.com/fabricjs/fabric.js/ > **height**: `number` -Defined in: [src/shapes/Text/Text.ts:99](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L99) +Defined in: [src/shapes/Text/Text.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L100) *** @@ -43,7 +43,7 @@ Defined in: [src/shapes/Text/Text.ts:99](https://github.com/fabricjs/fabric.js/b > **kernedWidth**: `number` -Defined in: [src/shapes/Text/Text.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L100) +Defined in: [src/shapes/Text/Text.ts:101](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L101) *** @@ -51,7 +51,7 @@ Defined in: [src/shapes/Text/Text.ts:100](https://github.com/fabricjs/fabric.js/ > **left**: `number` -Defined in: [src/shapes/Text/Text.ts:101](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L101) +Defined in: [src/shapes/Text/Text.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L102) *** @@ -59,7 +59,7 @@ Defined in: [src/shapes/Text/Text.ts:101](https://github.com/fabricjs/fabric.js/ > `optional` **renderLeft**: `number` -Defined in: [src/shapes/Text/Text.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L103) +Defined in: [src/shapes/Text/Text.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L104) *** @@ -67,7 +67,7 @@ Defined in: [src/shapes/Text/Text.ts:103](https://github.com/fabricjs/fabric.js/ > `optional` **renderTop**: `number` -Defined in: [src/shapes/Text/Text.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L104) +Defined in: [src/shapes/Text/Text.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L105) *** @@ -75,4 +75,4 @@ Defined in: [src/shapes/Text/Text.ts:104](https://github.com/fabricjs/fabric.js/ > **width**: `number` -Defined in: [src/shapes/Text/Text.ts:98](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L98) +Defined in: [src/shapes/Text/Text.ts:99](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L99) diff --git a/src/content/docs/api/type-aliases/GraphemeData.md b/src/content/docs/api/type-aliases/GraphemeData.md index 619433d3..5e57d09f 100644 --- a/src/content/docs/api/type-aliases/GraphemeData.md +++ b/src/content/docs/api/type-aliases/GraphemeData.md @@ -7,7 +7,7 @@ title: "GraphemeData" > **GraphemeData** = `object` -Defined in: [src/shapes/Textbox.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L24) +Defined in: [src/shapes/Textbox.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L24) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/shapes/Textbox.ts:24](https://github.com/fabricjs/fabric.js/blo > **largestWordWidth**: `number` -Defined in: [src/shapes/Textbox.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L29) +Defined in: [src/shapes/Textbox.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L29) *** @@ -23,4 +23,4 @@ Defined in: [src/shapes/Textbox.ts:29](https://github.com/fabricjs/fabric.js/blo > **wordsData**: `object`[][] -Defined in: [src/shapes/Textbox.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Textbox.ts#L25) +Defined in: [src/shapes/Textbox.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Textbox.ts#L25) diff --git a/src/content/docs/api/type-aliases/ITextEvents.md b/src/content/docs/api/type-aliases/ITextEvents.md index d8c6757d..2b856b5f 100644 --- a/src/content/docs/api/type-aliases/ITextEvents.md +++ b/src/content/docs/api/type-aliases/ITextEvents.md @@ -7,7 +7,7 @@ title: "ITextEvents" > **ITextEvents** = [`ObjectEvents`](/api/interfaces/objectevents/) & `object` -Defined in: [src/shapes/IText/ITextBehavior.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/IText/ITextBehavior.ts#L31) +Defined in: [src/shapes/IText/ITextBehavior.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/IText/ITextBehavior.ts#L31) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/ImageFormat.md b/src/content/docs/api/type-aliases/ImageFormat.md index 2784f243..80efcd8f 100644 --- a/src/content/docs/api/type-aliases/ImageFormat.md +++ b/src/content/docs/api/type-aliases/ImageFormat.md @@ -7,7 +7,7 @@ title: "ImageFormat" > **ImageFormat** = `"jpeg"` \| `"png"` \| `"webp"` -Defined in: [src/typedefs.ts:50](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L50) +Defined in: [src/typedefs.ts:50](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L50) In order to support webp on node canvas a workaround is needed and is shared here: https://github.com/Automattic/node-canvas/issues/1258 diff --git a/src/content/docs/api/type-aliases/ImageSource.md b/src/content/docs/api/type-aliases/ImageSource.md index cdb72189..2462d2e2 100644 --- a/src/content/docs/api/type-aliases/ImageSource.md +++ b/src/content/docs/api/type-aliases/ImageSource.md @@ -7,4 +7,4 @@ title: "ImageSource" > **ImageSource** = `HTMLImageElement` \| `HTMLVideoElement` \| `HTMLCanvasElement` -Defined in: [src/shapes/Image.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Image.ts#L38) +Defined in: [src/shapes/Image.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Image.ts#L38) diff --git a/src/content/docs/api/type-aliases/ImperativeLayoutContext.md b/src/content/docs/api/type-aliases/ImperativeLayoutContext.md index f9993d7c..5136078a 100644 --- a/src/content/docs/api/type-aliases/ImperativeLayoutContext.md +++ b/src/content/docs/api/type-aliases/ImperativeLayoutContext.md @@ -7,7 +7,7 @@ title: "ImperativeLayoutContext" > **ImperativeLayoutContext** = [`CommonLayoutContext`](/api/type-aliases/commonlayoutcontext/) & `ImperativeLayoutCommonOptions` & `object` -Defined in: [src/LayoutManager/types.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L115) +Defined in: [src/LayoutManager/types.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L115) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/ImperativeLayoutOptions.md b/src/content/docs/api/type-aliases/ImperativeLayoutOptions.md index 7130d6f8..4467d970 100644 --- a/src/content/docs/api/type-aliases/ImperativeLayoutOptions.md +++ b/src/content/docs/api/type-aliases/ImperativeLayoutOptions.md @@ -7,7 +7,7 @@ title: "ImperativeLayoutOptions" > **ImperativeLayoutOptions** = `ImperativeLayoutCommonOptions` & `object` -Defined in: [src/LayoutManager/types.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L70) +Defined in: [src/LayoutManager/types.ts:70](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L70) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/InitializationLayoutContext.md b/src/content/docs/api/type-aliases/InitializationLayoutContext.md index 73fc3e9e..6384c215 100644 --- a/src/content/docs/api/type-aliases/InitializationLayoutContext.md +++ b/src/content/docs/api/type-aliases/InitializationLayoutContext.md @@ -7,7 +7,7 @@ title: "InitializationLayoutContext" > **InitializationLayoutContext** = [`CommonLayoutContext`](/api/type-aliases/commonlayoutcontext/) & `object` -Defined in: [src/LayoutManager/types.ts:84](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L84) +Defined in: [src/LayoutManager/types.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L84) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/IntersectionType.md b/src/content/docs/api/type-aliases/IntersectionType.md index c4a23f12..9b53aae6 100644 --- a/src/content/docs/api/type-aliases/IntersectionType.md +++ b/src/content/docs/api/type-aliases/IntersectionType.md @@ -7,4 +7,4 @@ title: "IntersectionType" > **IntersectionType** = `"Intersection"` \| `"Coincident"` \| `"Parallel"` -Defined in: [src/Intersection.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Intersection.ts#L6) +Defined in: [src/Intersection.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Intersection.ts#L6) diff --git a/src/content/docs/api/type-aliases/LayoutAfterEvent.md b/src/content/docs/api/type-aliases/LayoutAfterEvent.md index 20cfe05a..3da21760 100644 --- a/src/content/docs/api/type-aliases/LayoutAfterEvent.md +++ b/src/content/docs/api/type-aliases/LayoutAfterEvent.md @@ -7,7 +7,7 @@ title: "LayoutAfterEvent" > **LayoutAfterEvent** = `object` -Defined in: [src/LayoutManager/types.ts:143](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L143) +Defined in: [src/LayoutManager/types.ts:143](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L143) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/LayoutManager/types.ts:143](https://github.com/fabricjs/fabric. > **context**: [`StrictLayoutContext`](/api/type-aliases/strictlayoutcontext/) -Defined in: [src/LayoutManager/types.ts:144](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L144) +Defined in: [src/LayoutManager/types.ts:144](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L144) *** @@ -23,6 +23,6 @@ Defined in: [src/LayoutManager/types.ts:144](https://github.com/fabricjs/fabric. > `optional` **result**: [`LayoutResult`](/api/type-aliases/layoutresult/) -Defined in: [src/LayoutManager/types.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L148) +Defined in: [src/LayoutManager/types.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L148) will be undefined if layout was skipped diff --git a/src/content/docs/api/type-aliases/LayoutBeforeEvent.md b/src/content/docs/api/type-aliases/LayoutBeforeEvent.md index c0571a95..6a5ea3b6 100644 --- a/src/content/docs/api/type-aliases/LayoutBeforeEvent.md +++ b/src/content/docs/api/type-aliases/LayoutBeforeEvent.md @@ -7,7 +7,7 @@ title: "LayoutBeforeEvent" > **LayoutBeforeEvent** = `object` -Defined in: [src/LayoutManager/types.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L139) +Defined in: [src/LayoutManager/types.ts:139](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L139) ## Properties @@ -15,4 +15,4 @@ Defined in: [src/LayoutManager/types.ts:139](https://github.com/fabricjs/fabric. > **context**: [`StrictLayoutContext`](/api/type-aliases/strictlayoutcontext/) -Defined in: [src/LayoutManager/types.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L140) +Defined in: [src/LayoutManager/types.ts:140](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L140) diff --git a/src/content/docs/api/type-aliases/LayoutContext.md b/src/content/docs/api/type-aliases/LayoutContext.md index cb938342..26e52326 100644 --- a/src/content/docs/api/type-aliases/LayoutContext.md +++ b/src/content/docs/api/type-aliases/LayoutContext.md @@ -7,4 +7,4 @@ title: "LayoutContext" > **LayoutContext** = [`InitializationLayoutContext`](/api/type-aliases/initializationlayoutcontext/) \| [`CollectionChangeLayoutContext`](/api/type-aliases/collectionchangelayoutcontext/) \| [`ObjectModifiedLayoutContext`](/api/type-aliases/objectmodifiedlayoutcontext/) \| [`ObjectModifyingLayoutContext`](/api/type-aliases/objectmodifyinglayoutcontext/) \| [`ImperativeLayoutContext`](/api/type-aliases/imperativelayoutcontext/) -Defined in: [src/LayoutManager/types.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L120) +Defined in: [src/LayoutManager/types.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L120) diff --git a/src/content/docs/api/type-aliases/LayoutResult.md b/src/content/docs/api/type-aliases/LayoutResult.md index 4e736a3d..d5118a10 100644 --- a/src/content/docs/api/type-aliases/LayoutResult.md +++ b/src/content/docs/api/type-aliases/LayoutResult.md @@ -7,7 +7,7 @@ title: "LayoutResult" > **LayoutResult** = `object` -Defined in: [src/LayoutManager/types.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L54) +Defined in: [src/LayoutManager/types.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L54) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/LayoutManager/types.ts:54](https://github.com/fabricjs/fabric.j > **nextCenter**: [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/types.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L57) +Defined in: [src/LayoutManager/types.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L57) *** @@ -23,7 +23,7 @@ Defined in: [src/LayoutManager/types.ts:57](https://github.com/fabricjs/fabric.j > **offset**: [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/types.ts:61](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L61) +Defined in: [src/LayoutManager/types.ts:61](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L61) The vector used to offset objects by, as measured by the plane @@ -33,7 +33,7 @@ The vector used to offset objects by, as measured by the plane > **prevCenter**: [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/types.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L56) +Defined in: [src/LayoutManager/types.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L56) *** @@ -41,4 +41,4 @@ Defined in: [src/LayoutManager/types.ts:56](https://github.com/fabricjs/fabric.j > `optional` **result**: [`LayoutStrategyResult`](/api/type-aliases/layoutstrategyresult/) -Defined in: [src/LayoutManager/types.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L55) +Defined in: [src/LayoutManager/types.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L55) diff --git a/src/content/docs/api/type-aliases/LayoutStrategyResult.md b/src/content/docs/api/type-aliases/LayoutStrategyResult.md index e812161f..e55aac69 100644 --- a/src/content/docs/api/type-aliases/LayoutStrategyResult.md +++ b/src/content/docs/api/type-aliases/LayoutStrategyResult.md @@ -7,7 +7,7 @@ title: "LayoutStrategyResult" > **LayoutStrategyResult** = `object` -Defined in: [src/LayoutManager/types.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L28) +Defined in: [src/LayoutManager/types.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L28) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/LayoutManager/types.ts:28](https://github.com/fabricjs/fabric.j > **center**: [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/types.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L32) +Defined in: [src/LayoutManager/types.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L32) new center point as measured by the **containing** plane (same as `left` with `originX` set to `center`) @@ -25,7 +25,7 @@ new center point as measured by the **containing** plane (same as `left` with `o > `optional` **correction**: [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/types.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L41) +Defined in: [src/LayoutManager/types.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L41) correction vector to translate objects by, measured in the same plane as `center` @@ -39,7 +39,7 @@ In other words, this value makes it possible to layout objects relative to the t > `optional` **relativeCorrection**: [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/types.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L46) +Defined in: [src/LayoutManager/types.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L46) correction vector to translate objects by as measured by the plane @@ -49,6 +49,6 @@ correction vector to translate objects by as measured by the plane > **size**: [`Point`](/api/classes/point/) -Defined in: [src/LayoutManager/types.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L51) +Defined in: [src/LayoutManager/types.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L51) new width and height of the layout target diff --git a/src/content/docs/api/type-aliases/LayoutTrigger.md b/src/content/docs/api/type-aliases/LayoutTrigger.md index 879931e2..6d6f9f75 100644 --- a/src/content/docs/api/type-aliases/LayoutTrigger.md +++ b/src/content/docs/api/type-aliases/LayoutTrigger.md @@ -7,4 +7,4 @@ title: "LayoutTrigger" > **LayoutTrigger** = *typeof* `LAYOUT_TYPE_INITIALIZATION` \| *typeof* `LAYOUT_TYPE_OBJECT_MODIFYING` \| *typeof* `LAYOUT_TYPE_OBJECT_MODIFIED` \| *typeof* `LAYOUT_TYPE_ADDED` \| *typeof* `LAYOUT_TYPE_REMOVED` \| *typeof* `LAYOUT_TYPE_IMPERATIVE` -Defined in: [src/LayoutManager/types.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L20) +Defined in: [src/LayoutManager/types.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L20) diff --git a/src/content/docs/api/type-aliases/LinearGradientCoords.md b/src/content/docs/api/type-aliases/LinearGradientCoords.md index a044d381..63397120 100644 --- a/src/content/docs/api/type-aliases/LinearGradientCoords.md +++ b/src/content/docs/api/type-aliases/LinearGradientCoords.md @@ -7,7 +7,7 @@ title: "LinearGradientCoords" > **LinearGradientCoords**\<`T`\> = `object` -Defined in: [src/gradient/typedefs.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L14) +Defined in: [src/gradient/typedefs.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L14) ## Type Parameters @@ -21,9 +21,9 @@ Defined in: [src/gradient/typedefs.ts:14](https://github.com/fabricjs/fabric.js/ > **x1**: `T` -Defined in: [src/gradient/typedefs.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L18) +Defined in: [src/gradient/typedefs.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L18) -X coordiante of the first point +X coordinate of the first point *** @@ -31,9 +31,9 @@ X coordiante of the first point > **x2**: `T` -Defined in: [src/gradient/typedefs.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L26) +Defined in: [src/gradient/typedefs.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L26) -X coordiante of the second point +X coordinate of the second point *** @@ -41,9 +41,9 @@ X coordiante of the second point > **y1**: `T` -Defined in: [src/gradient/typedefs.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L22) +Defined in: [src/gradient/typedefs.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L22) -Y coordiante of the first point +Y coordinate of the first point *** @@ -51,6 +51,6 @@ Y coordiante of the first point > **y2**: `T` -Defined in: [src/gradient/typedefs.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L30) +Defined in: [src/gradient/typedefs.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L30) -Y coordiante of the second point +Y coordinate of the second point diff --git a/src/content/docs/api/type-aliases/ModifierKey.md b/src/content/docs/api/type-aliases/ModifierKey.md index 72eeb59a..1fcf7867 100644 --- a/src/content/docs/api/type-aliases/ModifierKey.md +++ b/src/content/docs/api/type-aliases/ModifierKey.md @@ -7,4 +7,4 @@ title: "ModifierKey" > **ModifierKey** = keyof `Pick`\<`MouseEvent` \| `PointerEvent` \| `TouchEvent`, `"altKey"` \| `"shiftKey"` \| `"ctrlKey"` \| `"metaKey"`\> -Defined in: [src/EventTypeDefs.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L26) +Defined in: [src/EventTypeDefs.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L26) diff --git a/src/content/docs/api/type-aliases/MultiSelectionStacking.md b/src/content/docs/api/type-aliases/MultiSelectionStacking.md index b88edd04..b06dce1d 100644 --- a/src/content/docs/api/type-aliases/MultiSelectionStacking.md +++ b/src/content/docs/api/type-aliases/MultiSelectionStacking.md @@ -7,4 +7,4 @@ title: "MultiSelectionStacking" > **MultiSelectionStacking** = `"canvas-stacking"` \| `"selection-order"` -Defined in: [src/shapes/ActiveSelection.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/ActiveSelection.ts#L14) +Defined in: [src/shapes/ActiveSelection.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/ActiveSelection.ts#L14) diff --git a/src/content/docs/api/type-aliases/ObjectModificationEvents.md b/src/content/docs/api/type-aliases/ObjectModificationEvents.md index 691b30f4..78b62276 100644 --- a/src/content/docs/api/type-aliases/ObjectModificationEvents.md +++ b/src/content/docs/api/type-aliases/ObjectModificationEvents.md @@ -7,7 +7,7 @@ title: "ObjectModificationEvents" > **ObjectModificationEvents** = `object` -Defined in: [src/EventTypeDefs.ts:142](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L142) +Defined in: [src/EventTypeDefs.ts:142](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L142) ## Extended by @@ -19,7 +19,7 @@ Defined in: [src/EventTypeDefs.ts:142](https://github.com/fabricjs/fabric.js/blo > **modified**: [`ModifiedEvent`](/api/interfaces/modifiedevent/) -Defined in: [src/EventTypeDefs.ts:150](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L150) +Defined in: [src/EventTypeDefs.ts:150](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L150) *** @@ -27,7 +27,7 @@ Defined in: [src/EventTypeDefs.ts:150](https://github.com/fabricjs/fabric.js/blo > **modifyPath**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) & [`ModifyPathEvent`](/api/interfaces/modifypathevent/) -Defined in: [src/EventTypeDefs.ts:149](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L149) +Defined in: [src/EventTypeDefs.ts:149](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L149) *** @@ -35,7 +35,7 @@ Defined in: [src/EventTypeDefs.ts:149](https://github.com/fabricjs/fabric.js/blo > **modifyPoly**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:148](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L148) +Defined in: [src/EventTypeDefs.ts:148](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L148) *** @@ -43,7 +43,7 @@ Defined in: [src/EventTypeDefs.ts:148](https://github.com/fabricjs/fabric.js/blo > **moving**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:143](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L143) +Defined in: [src/EventTypeDefs.ts:143](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L143) *** @@ -51,7 +51,7 @@ Defined in: [src/EventTypeDefs.ts:143](https://github.com/fabricjs/fabric.js/blo > **resizing**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:147](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L147) +Defined in: [src/EventTypeDefs.ts:147](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L147) *** @@ -59,7 +59,7 @@ Defined in: [src/EventTypeDefs.ts:147](https://github.com/fabricjs/fabric.js/blo > **rotating**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:145](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L145) +Defined in: [src/EventTypeDefs.ts:145](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L145) *** @@ -67,7 +67,7 @@ Defined in: [src/EventTypeDefs.ts:145](https://github.com/fabricjs/fabric.js/blo > **scaling**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:144](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L144) +Defined in: [src/EventTypeDefs.ts:144](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L144) *** @@ -75,4 +75,4 @@ Defined in: [src/EventTypeDefs.ts:144](https://github.com/fabricjs/fabric.js/blo > **skewing**: [`BasicTransformEvent`](/api/interfaces/basictransformevent/) -Defined in: [src/EventTypeDefs.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L146) +Defined in: [src/EventTypeDefs.ts:146](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L146) diff --git a/src/content/docs/api/type-aliases/ObjectModifiedLayoutContext.md b/src/content/docs/api/type-aliases/ObjectModifiedLayoutContext.md index 33b96c3f..97267338 100644 --- a/src/content/docs/api/type-aliases/ObjectModifiedLayoutContext.md +++ b/src/content/docs/api/type-aliases/ObjectModifiedLayoutContext.md @@ -7,7 +7,7 @@ title: "ObjectModifiedLayoutContext" > **ObjectModifiedLayoutContext** = [`CommonLayoutContext`](/api/type-aliases/commonlayoutcontext/) & `object` -Defined in: [src/LayoutManager/types.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L96) +Defined in: [src/LayoutManager/types.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L96) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/ObjectModifyingLayoutContext.md b/src/content/docs/api/type-aliases/ObjectModifyingLayoutContext.md index e79bf07a..64fece6f 100644 --- a/src/content/docs/api/type-aliases/ObjectModifyingLayoutContext.md +++ b/src/content/docs/api/type-aliases/ObjectModifyingLayoutContext.md @@ -7,7 +7,7 @@ title: "ObjectModifyingLayoutContext" > **ObjectModifyingLayoutContext** = [`CommonLayoutContext`](/api/type-aliases/commonlayoutcontext/) & `object` & \{ `e`: [`BasicTransformEvent`](/api/interfaces/basictransformevent/); `trigger`: [`TModificationEvents`](/api/type-aliases/tmodificationevents/); \} \| \{ `e`: [`ITextEvents`](/api/type-aliases/itextevents/)\[`"changed"`\]; `trigger`: `"changed"`; \} -Defined in: [src/LayoutManager/types.ts:102](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L102) +Defined in: [src/LayoutManager/types.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L102) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/ObjectPointerEvents.md b/src/content/docs/api/type-aliases/ObjectPointerEvents.md index 14af60c1..01455fa0 100644 --- a/src/content/docs/api/type-aliases/ObjectPointerEvents.md +++ b/src/content/docs/api/type-aliases/ObjectPointerEvents.md @@ -7,4 +7,4 @@ title: "ObjectPointerEvents" > **ObjectPointerEvents** = `TPointerEvents`\<`"mouse"`\> -Defined in: [src/EventTypeDefs.ts:285](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L285) +Defined in: [src/EventTypeDefs.ts:289](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L289) diff --git a/src/content/docs/api/type-aliases/PatternOptions.md b/src/content/docs/api/type-aliases/PatternOptions.md index ab442754..6ae62044 100644 --- a/src/content/docs/api/type-aliases/PatternOptions.md +++ b/src/content/docs/api/type-aliases/PatternOptions.md @@ -7,7 +7,7 @@ title: "PatternOptions" > **PatternOptions** = `Partial`\<`Pick`\<[`Pattern`](/api/classes/pattern/), `ExportedKeys`\>\> & `object` -Defined in: [src/Pattern/types.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/types.ts#L13) +Defined in: [src/Pattern/types.ts:13](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/types.ts#L13) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/PatternRepeat.md b/src/content/docs/api/type-aliases/PatternRepeat.md index b230e86d..a8c46279 100644 --- a/src/content/docs/api/type-aliases/PatternRepeat.md +++ b/src/content/docs/api/type-aliases/PatternRepeat.md @@ -7,4 +7,4 @@ title: "PatternRepeat" > **PatternRepeat** = `"repeat"` \| `"repeat-x"` \| `"repeat-y"` \| `"no-repeat"` -Defined in: [src/Pattern/types.ts:3](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/types.ts#L3) +Defined in: [src/Pattern/types.ts:3](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/types.ts#L3) diff --git a/src/content/docs/api/type-aliases/Percent.md b/src/content/docs/api/type-aliases/Percent.md index 41cbc7b1..60394509 100644 --- a/src/content/docs/api/type-aliases/Percent.md +++ b/src/content/docs/api/type-aliases/Percent.md @@ -7,4 +7,4 @@ title: "Percent" > **Percent** = `` `${number}%` `` -Defined in: [src/typedefs.ts:44](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L44) +Defined in: [src/typedefs.ts:44](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L44) diff --git a/src/content/docs/api/type-aliases/RadialGradientCoords.md b/src/content/docs/api/type-aliases/RadialGradientCoords.md index 1d152492..5726d13a 100644 --- a/src/content/docs/api/type-aliases/RadialGradientCoords.md +++ b/src/content/docs/api/type-aliases/RadialGradientCoords.md @@ -7,7 +7,7 @@ title: "RadialGradientCoords" > **RadialGradientCoords**\<`T`\> = `object` -Defined in: [src/gradient/typedefs.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L33) +Defined in: [src/gradient/typedefs.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L33) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [src/gradient/typedefs.ts:33](https://github.com/fabricjs/fabric.js/ > **r1**: `T` -Defined in: [src/gradient/typedefs.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L53) +Defined in: [src/gradient/typedefs.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L53) radius of the inner circle @@ -31,7 +31,7 @@ radius of the inner circle > **r2**: `T` -Defined in: [src/gradient/typedefs.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L57) +Defined in: [src/gradient/typedefs.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L57) radius of the outer circle @@ -41,7 +41,7 @@ radius of the outer circle > **x1**: `T` -Defined in: [src/gradient/typedefs.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L37) +Defined in: [src/gradient/typedefs.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L37) X coordinate of the first focal point @@ -51,9 +51,9 @@ X coordinate of the first focal point > **x2**: `T` -Defined in: [src/gradient/typedefs.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L45) +Defined in: [src/gradient/typedefs.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L45) -X coordiante of the second focal point +X coordinate of the second focal point *** @@ -61,9 +61,9 @@ X coordiante of the second focal point > **y1**: `T` -Defined in: [src/gradient/typedefs.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L41) +Defined in: [src/gradient/typedefs.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L41) -Y coordiante of the first focal point +Y coordinate of the first focal point *** @@ -71,6 +71,6 @@ Y coordiante of the first focal point > **y2**: `T` -Defined in: [src/gradient/typedefs.ts:49](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L49) +Defined in: [src/gradient/typedefs.ts:49](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L49) -Y coordiante of the second focal point +Y coordinate of the second focal point diff --git a/src/content/docs/api/type-aliases/RegistrationContext.md b/src/content/docs/api/type-aliases/RegistrationContext.md index 267c7e6e..419825cd 100644 --- a/src/content/docs/api/type-aliases/RegistrationContext.md +++ b/src/content/docs/api/type-aliases/RegistrationContext.md @@ -7,7 +7,7 @@ title: "RegistrationContext" > **RegistrationContext** = `object` -Defined in: [src/LayoutManager/types.ts:134](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L134) +Defined in: [src/LayoutManager/types.ts:134](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L134) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/LayoutManager/types.ts:134](https://github.com/fabricjs/fabric. > **target**: [`Group`](/api/classes/group/) -Defined in: [src/LayoutManager/types.ts:136](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L136) +Defined in: [src/LayoutManager/types.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L136) *** @@ -23,4 +23,4 @@ Defined in: [src/LayoutManager/types.ts:136](https://github.com/fabricjs/fabric. > **targets**: [`FabricObject`](/api/classes/fabricobject/)[] -Defined in: [src/LayoutManager/types.ts:135](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L135) +Defined in: [src/LayoutManager/types.ts:135](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L135) diff --git a/src/content/docs/api/type-aliases/SVGElementName.md b/src/content/docs/api/type-aliases/SVGElementName.md index e1e24fe1..89d49899 100644 --- a/src/content/docs/api/type-aliases/SVGElementName.md +++ b/src/content/docs/api/type-aliases/SVGElementName.md @@ -7,4 +7,4 @@ title: "SVGElementName" > **SVGElementName** = `"linearGradient"` \| `"radialGradient"` \| `"stop"` -Defined in: [src/typedefs.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L52) +Defined in: [src/typedefs.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L52) diff --git a/src/content/docs/api/type-aliases/SVGOptions.md b/src/content/docs/api/type-aliases/SVGOptions.md index b94406c3..4bc51ca0 100644 --- a/src/content/docs/api/type-aliases/SVGOptions.md +++ b/src/content/docs/api/type-aliases/SVGOptions.md @@ -7,7 +7,7 @@ title: "SVGOptions" > **SVGOptions** = `object` -Defined in: [src/gradient/typedefs.ts:84](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L84) +Defined in: [src/gradient/typedefs.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L84) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/gradient/typedefs.ts:84](https://github.com/fabricjs/fabric.js/ > **height**: `number` -Defined in: [src/gradient/typedefs.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L100) +Defined in: [src/gradient/typedefs.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L100) height part of the svg tag if viewBox is not specified @@ -25,7 +25,7 @@ height part of the svg tag if viewBox is not specified > **opacity**: `string` \| `null` -Defined in: [src/gradient/typedefs.ts:102](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L102) +Defined in: [src/gradient/typedefs.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L102) *** @@ -33,7 +33,7 @@ Defined in: [src/gradient/typedefs.ts:102](https://github.com/fabricjs/fabric.js > **viewBoxHeight**: `number` -Defined in: [src/gradient/typedefs.ts:92](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L92) +Defined in: [src/gradient/typedefs.ts:92](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L92) height part of the viewBox attribute on svg @@ -43,7 +43,7 @@ height part of the viewBox attribute on svg > **viewBoxWidth**: `number` -Defined in: [src/gradient/typedefs.ts:88](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L88) +Defined in: [src/gradient/typedefs.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L88) width part of the viewBox attribute on svg @@ -53,6 +53,6 @@ width part of the viewBox attribute on svg > **width**: `number` -Defined in: [src/gradient/typedefs.ts:96](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L96) +Defined in: [src/gradient/typedefs.ts:96](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L96) width part of the svg tag if viewBox is not specified diff --git a/src/content/docs/api/type-aliases/SerializedGradientProps.md b/src/content/docs/api/type-aliases/SerializedGradientProps.md index e380cdb3..9a628e8c 100644 --- a/src/content/docs/api/type-aliases/SerializedGradientProps.md +++ b/src/content/docs/api/type-aliases/SerializedGradientProps.md @@ -7,7 +7,7 @@ title: "SerializedGradientProps" > **SerializedGradientProps**\<`T`\> = `Omit`\<[`GradientOptions`](/api/type-aliases/gradientoptions/)\<`T`\>, `"id"`\> -Defined in: [src/gradient/typedefs.ts:105](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/gradient/typedefs.ts#L105) +Defined in: [src/gradient/typedefs.ts:105](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/gradient/typedefs.ts#L105) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/SerializedLayoutManager.md b/src/content/docs/api/type-aliases/SerializedLayoutManager.md index 9498635c..ef085028 100644 --- a/src/content/docs/api/type-aliases/SerializedLayoutManager.md +++ b/src/content/docs/api/type-aliases/SerializedLayoutManager.md @@ -7,7 +7,7 @@ title: "SerializedLayoutManager" > **SerializedLayoutManager** = `object` -Defined in: [src/LayoutManager/LayoutManager.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L40) +Defined in: [src/LayoutManager/LayoutManager.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L40) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/LayoutManager/LayoutManager.ts:40](https://github.com/fabricjs/ > **strategy**: `string` -Defined in: [src/LayoutManager/LayoutManager.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L42) +Defined in: [src/LayoutManager/LayoutManager.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L42) *** @@ -23,4 +23,4 @@ Defined in: [src/LayoutManager/LayoutManager.ts:42](https://github.com/fabricjs/ > **type**: `string` -Defined in: [src/LayoutManager/LayoutManager.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/LayoutManager.ts#L41) +Defined in: [src/LayoutManager/LayoutManager.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/LayoutManager.ts#L41) diff --git a/src/content/docs/api/type-aliases/SerializedPatternOptions.md b/src/content/docs/api/type-aliases/SerializedPatternOptions.md index 14923748..b436c93a 100644 --- a/src/content/docs/api/type-aliases/SerializedPatternOptions.md +++ b/src/content/docs/api/type-aliases/SerializedPatternOptions.md @@ -7,7 +7,7 @@ title: "SerializedPatternOptions" > **SerializedPatternOptions** = `Omit`\<[`PatternOptions`](/api/type-aliases/patternoptions/), `"source"`\> & `object` -Defined in: [src/Pattern/types.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Pattern/types.ts#L17) +Defined in: [src/Pattern/types.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Pattern/types.ts#L17) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/SerializedShadowOptions.md b/src/content/docs/api/type-aliases/SerializedShadowOptions.md index fc057be4..642173f6 100644 --- a/src/content/docs/api/type-aliases/SerializedShadowOptions.md +++ b/src/content/docs/api/type-aliases/SerializedShadowOptions.md @@ -7,7 +7,7 @@ title: "SerializedShadowOptions" > **SerializedShadowOptions** = `object` -Defined in: [src/Shadow.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L53) +Defined in: [src/Shadow.ts:53](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L53) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/Shadow.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4 > **affectStroke**: `boolean` -Defined in: [src/Shadow.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L58) +Defined in: [src/Shadow.ts:58](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L58) *** @@ -23,7 +23,7 @@ Defined in: [src/Shadow.ts:58](https://github.com/fabricjs/fabric.js/blob/22fda4 > **blur**: `number` -Defined in: [src/Shadow.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L55) +Defined in: [src/Shadow.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L55) *** @@ -31,7 +31,7 @@ Defined in: [src/Shadow.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4 > **color**: `string` -Defined in: [src/Shadow.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L54) +Defined in: [src/Shadow.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L54) *** @@ -39,7 +39,7 @@ Defined in: [src/Shadow.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4 > **nonScaling**: `boolean` -Defined in: [src/Shadow.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L59) +Defined in: [src/Shadow.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L59) *** @@ -47,7 +47,7 @@ Defined in: [src/Shadow.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4 > **offsetX**: `number` -Defined in: [src/Shadow.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L56) +Defined in: [src/Shadow.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L56) *** @@ -55,7 +55,7 @@ Defined in: [src/Shadow.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4 > **offsetY**: `number` -Defined in: [src/Shadow.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L57) +Defined in: [src/Shadow.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L57) *** @@ -63,4 +63,4 @@ Defined in: [src/Shadow.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4 > **type**: `string` -Defined in: [src/Shadow.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/Shadow.ts#L60) +Defined in: [src/Shadow.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/Shadow.ts#L60) diff --git a/src/content/docs/api/type-aliases/SprayBrushPoint.md b/src/content/docs/api/type-aliases/SprayBrushPoint.md index 87bd1b68..e868f61a 100644 --- a/src/content/docs/api/type-aliases/SprayBrushPoint.md +++ b/src/content/docs/api/type-aliases/SprayBrushPoint.md @@ -7,7 +7,7 @@ title: "SprayBrushPoint" > **SprayBrushPoint** = `object` -Defined in: [src/brushes/typedefs.ts:13](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L13) +Defined in: [src/brushes/typedefs.ts:13](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L13) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/brushes/typedefs.ts:13](https://github.com/fabricjs/fabric.js/b > **opacity**: `number` -Defined in: [src/brushes/typedefs.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L17) +Defined in: [src/brushes/typedefs.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L17) *** @@ -23,7 +23,7 @@ Defined in: [src/brushes/typedefs.ts:17](https://github.com/fabricjs/fabric.js/b > **width**: `number` -Defined in: [src/brushes/typedefs.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L16) +Defined in: [src/brushes/typedefs.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L16) *** @@ -31,7 +31,7 @@ Defined in: [src/brushes/typedefs.ts:16](https://github.com/fabricjs/fabric.js/b > **x**: `number` -Defined in: [src/brushes/typedefs.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L14) +Defined in: [src/brushes/typedefs.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L14) *** @@ -39,4 +39,4 @@ Defined in: [src/brushes/typedefs.ts:14](https://github.com/fabricjs/fabric.js/b > **y**: `number` -Defined in: [src/brushes/typedefs.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L15) +Defined in: [src/brushes/typedefs.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L15) diff --git a/src/content/docs/api/type-aliases/StrictLayoutContext.md b/src/content/docs/api/type-aliases/StrictLayoutContext.md index 6dfd3622..d0105265 100644 --- a/src/content/docs/api/type-aliases/StrictLayoutContext.md +++ b/src/content/docs/api/type-aliases/StrictLayoutContext.md @@ -7,7 +7,7 @@ title: "StrictLayoutContext" > **StrictLayoutContext** = [`LayoutContext`](/api/type-aliases/layoutcontext/) & `object` -Defined in: [src/LayoutManager/types.ts:127](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/LayoutManager/types.ts#L127) +Defined in: [src/LayoutManager/types.ts:127](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/LayoutManager/types.ts#L127) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/SupportedSVGUnit.md b/src/content/docs/api/type-aliases/SupportedSVGUnit.md index 1d0c0741..bc1dc492 100644 --- a/src/content/docs/api/type-aliases/SupportedSVGUnit.md +++ b/src/content/docs/api/type-aliases/SupportedSVGUnit.md @@ -7,4 +7,4 @@ title: "SupportedSVGUnit" > **SupportedSVGUnit** = `"mm"` \| `"cm"` \| `"in"` \| `"pt"` \| `"pc"` \| `"em"` -Defined in: [src/typedefs.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L54) +Defined in: [src/typedefs.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L54) diff --git a/src/content/docs/api/type-aliases/T2DPipelineState.md b/src/content/docs/api/type-aliases/T2DPipelineState.md index a4b61fa2..eb3aa625 100644 --- a/src/content/docs/api/type-aliases/T2DPipelineState.md +++ b/src/content/docs/api/type-aliases/T2DPipelineState.md @@ -7,7 +7,7 @@ title: "T2DPipelineState" > **T2DPipelineState** = `object` -Defined in: [src/filters/typedefs.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L35) +Defined in: [src/filters/typedefs.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L35) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/filters/typedefs.ts:35](https://github.com/fabricjs/fabric.js/b > **canvasEl**: `HTMLCanvasElement` -Defined in: [src/filters/typedefs.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L39) +Defined in: [src/filters/typedefs.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L39) *** @@ -23,7 +23,7 @@ Defined in: [src/filters/typedefs.ts:39](https://github.com/fabricjs/fabric.js/b > **ctx**: `CanvasRenderingContext2D` -Defined in: [src/filters/typedefs.ts:43](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L43) +Defined in: [src/filters/typedefs.ts:43](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L43) *** @@ -31,7 +31,7 @@ Defined in: [src/filters/typedefs.ts:43](https://github.com/fabricjs/fabric.js/b > **filterBackend**: [`Canvas2dFilterBackend`](/api/classes/canvas2dfilterbackend/) -Defined in: [src/filters/typedefs.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L38) +Defined in: [src/filters/typedefs.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L38) *** @@ -39,7 +39,7 @@ Defined in: [src/filters/typedefs.ts:38](https://github.com/fabricjs/fabric.js/b > `optional` **helpLayer**: `HTMLCanvasElement` -Defined in: [src/filters/typedefs.ts:44](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L44) +Defined in: [src/filters/typedefs.ts:44](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L44) *** @@ -47,7 +47,7 @@ Defined in: [src/filters/typedefs.ts:44](https://github.com/fabricjs/fabric.js/b > **imageData**: `ImageData` -Defined in: [src/filters/typedefs.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L40) +Defined in: [src/filters/typedefs.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L40) *** @@ -55,7 +55,7 @@ Defined in: [src/filters/typedefs.ts:40](https://github.com/fabricjs/fabric.js/b > **originalEl**: `CanvasImageSource` -Defined in: [src/filters/typedefs.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L41) +Defined in: [src/filters/typedefs.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L41) *** @@ -63,7 +63,7 @@ Defined in: [src/filters/typedefs.ts:41](https://github.com/fabricjs/fabric.js/b > `optional` **originalImageData**: `ImageData` -Defined in: [src/filters/typedefs.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L42) +Defined in: [src/filters/typedefs.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L42) *** @@ -71,7 +71,7 @@ Defined in: [src/filters/typedefs.ts:42](https://github.com/fabricjs/fabric.js/b > **sourceHeight**: `number` -Defined in: [src/filters/typedefs.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L37) +Defined in: [src/filters/typedefs.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L37) *** @@ -79,4 +79,4 @@ Defined in: [src/filters/typedefs.ts:37](https://github.com/fabricjs/fabric.js/b > **sourceWidth**: `number` -Defined in: [src/filters/typedefs.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L36) +Defined in: [src/filters/typedefs.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L36) diff --git a/src/content/docs/api/type-aliases/TArcCommand.md b/src/content/docs/api/type-aliases/TArcCommand.md index 340feab8..4deca9b0 100644 --- a/src/content/docs/api/type-aliases/TArcCommand.md +++ b/src/content/docs/api/type-aliases/TArcCommand.md @@ -7,4 +7,4 @@ title: "TArcCommand" > **TArcCommand** = `TCommand8`\<[`TParsedArcCommand`](/api/type-aliases/tparsedarccommand/)\> \| [`TArcCommandSingleFlag`](/api/type-aliases/tarccommandsingleflag/)\<[`TParsedArcCommand`](/api/type-aliases/tparsedarccommand/)\> -Defined in: [src/util/path/typedefs.ts:255](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L255) +Defined in: [src/util/path/typedefs.ts:255](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L255) diff --git a/src/content/docs/api/type-aliases/TArcCommandSingleFlag.md b/src/content/docs/api/type-aliases/TArcCommandSingleFlag.md index 0a521eeb..26c0db9f 100644 --- a/src/content/docs/api/type-aliases/TArcCommandSingleFlag.md +++ b/src/content/docs/api/type-aliases/TArcCommandSingleFlag.md @@ -7,7 +7,7 @@ title: "TArcCommandSingleFlag" > **TArcCommandSingleFlag**\<`T`\> = `` `${T[0]} ${T[1]} ${T[2]} ${T[3]} ${T[4]}${T[5]} ${T[6]} ${T[7]}` `` -Defined in: [src/util/path/typedefs.ts:253](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L253) +Defined in: [src/util/path/typedefs.ts:253](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L253) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/TAxis.md b/src/content/docs/api/type-aliases/TAxis.md index 7022f48b..0a8173e2 100644 --- a/src/content/docs/api/type-aliases/TAxis.md +++ b/src/content/docs/api/type-aliases/TAxis.md @@ -7,4 +7,4 @@ title: "TAxis" > **TAxis** = `"x"` \| `"y"` -Defined in: [src/typedefs.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L28) +Defined in: [src/typedefs.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L28) diff --git a/src/content/docs/api/type-aliases/TAxisKey.md b/src/content/docs/api/type-aliases/TAxisKey.md index f405ae80..99f458a1 100644 --- a/src/content/docs/api/type-aliases/TAxisKey.md +++ b/src/content/docs/api/type-aliases/TAxisKey.md @@ -7,7 +7,7 @@ title: "TAxisKey" > **TAxisKey**\<`T`\> = `` `${T}${Capitalize}` `` -Defined in: [src/typedefs.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L30) +Defined in: [src/typedefs.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L30) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/TBBox.md b/src/content/docs/api/type-aliases/TBBox.md index 4700a0d4..d18d8b7f 100644 --- a/src/content/docs/api/type-aliases/TBBox.md +++ b/src/content/docs/api/type-aliases/TBBox.md @@ -7,7 +7,7 @@ title: "TBBox" > **TBBox** = `object` & [`TSize`](/api/type-aliases/tsize/) -Defined in: [src/typedefs.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L39) +Defined in: [src/typedefs.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L39) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/TBrushEventData.md b/src/content/docs/api/type-aliases/TBrushEventData.md index 5b8e4b81..05cc4be1 100644 --- a/src/content/docs/api/type-aliases/TBrushEventData.md +++ b/src/content/docs/api/type-aliases/TBrushEventData.md @@ -7,7 +7,7 @@ title: "TBrushEventData" > **TBrushEventData** = [`TEvent`](/api/interfaces/tevent/) & `object` -Defined in: [src/brushes/typedefs.ts:4](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/brushes/typedefs.ts#L4) +Defined in: [src/brushes/typedefs.ts:4](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/brushes/typedefs.ts#L4) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/TCacheCanvasDimensions.md b/src/content/docs/api/type-aliases/TCacheCanvasDimensions.md index 3059fb6e..f387565a 100644 --- a/src/content/docs/api/type-aliases/TCacheCanvasDimensions.md +++ b/src/content/docs/api/type-aliases/TCacheCanvasDimensions.md @@ -7,7 +7,7 @@ title: "TCacheCanvasDimensions" > **TCacheCanvasDimensions** = [`TSize`](/api/type-aliases/tsize/) & `object` -Defined in: [src/typedefs.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L93) +Defined in: [src/typedefs.ts:93](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L93) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/TCanvasSizeOptions.md b/src/content/docs/api/type-aliases/TCanvasSizeOptions.md index e9fad479..92fb4d94 100644 --- a/src/content/docs/api/type-aliases/TCanvasSizeOptions.md +++ b/src/content/docs/api/type-aliases/TCanvasSizeOptions.md @@ -7,7 +7,7 @@ title: "TCanvasSizeOptions" > **TCanvasSizeOptions** = \{ `backstoreOnly?`: `true`; `cssOnly?`: `false`; \} \| \{ `backstoreOnly?`: `false`; `cssOnly?`: `true`; \} -Defined in: [src/canvas/StaticCanvas.ts:53](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L53) +Defined in: [src/canvas/StaticCanvas.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L57) Having both options in TCanvasSizeOptions set to true transform the call in a calcOffset Better try to restrict with types to avoid confusion. diff --git a/src/content/docs/api/type-aliases/TClassProperties.md b/src/content/docs/api/type-aliases/TClassProperties.md index 1d1efcf9..2c15a9be 100644 --- a/src/content/docs/api/type-aliases/TClassProperties.md +++ b/src/content/docs/api/type-aliases/TClassProperties.md @@ -7,7 +7,7 @@ title: "TClassProperties" > **TClassProperties**\<`T`\> = `Pick`\<`T`, `TNonFunctionPropertyNames`\<`T`\>\> -Defined in: [src/typedefs.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L17) +Defined in: [src/typedefs.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L17) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/TClosePathCommand.md b/src/content/docs/api/type-aliases/TClosePathCommand.md index fe81d0ae..8e880604 100644 --- a/src/content/docs/api/type-aliases/TClosePathCommand.md +++ b/src/content/docs/api/type-aliases/TClosePathCommand.md @@ -7,4 +7,4 @@ title: "TClosePathCommand" > **TClosePathCommand** = `TCommand1`\<[`TParsedClosePathCommand`](/api/type-aliases/tparsedclosepathcommand/)\> -Defined in: [src/util/path/typedefs.ts:144](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L144) +Defined in: [src/util/path/typedefs.ts:144](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L144) diff --git a/src/content/docs/api/type-aliases/TColorArg.md b/src/content/docs/api/type-aliases/TColorArg.md index 2a2313f5..9062b4e4 100644 --- a/src/content/docs/api/type-aliases/TColorArg.md +++ b/src/content/docs/api/type-aliases/TColorArg.md @@ -7,4 +7,4 @@ title: "TColorArg" > **TColorArg** = `string` \| [`TRGBColorSource`](/api/type-aliases/trgbcolorsource/) \| [`TRGBAColorSource`](/api/type-aliases/trgbacolorsource/) \| [`Color`](/api/classes/color/) -Defined in: [src/color/typedefs.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/typedefs.ts#L18) +Defined in: [src/color/typedefs.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/typedefs.ts#L18) diff --git a/src/content/docs/api/type-aliases/TComplexParsedCommand.md b/src/content/docs/api/type-aliases/TComplexParsedCommand.md index 89538163..17408360 100644 --- a/src/content/docs/api/type-aliases/TComplexParsedCommand.md +++ b/src/content/docs/api/type-aliases/TComplexParsedCommand.md @@ -7,6 +7,6 @@ title: "TComplexParsedCommand" > **TComplexParsedCommand** = [`TParsedMoveToCommand`](/api/type-aliases/tparsedmovetocommand/) \| [`TParsedLineCommand`](/api/type-aliases/tparsedlinecommand/) \| [`TParsedHorizontalLineCommand`](/api/type-aliases/tparsedhorizontallinecommand/) \| [`TParsedVerticalLineCommand`](/api/type-aliases/tparsedverticallinecommand/) \| [`TParsedClosePathCommand`](/api/type-aliases/tparsedclosepathcommand/) \| [`TParsedCubicCurveCommand`](/api/type-aliases/tparsedcubiccurvecommand/) \| [`TParsedCubicCurveShortcutCommand`](/api/type-aliases/tparsedcubiccurveshortcutcommand/) \| [`TParsedQuadraticCurveCommand`](/api/type-aliases/tparsedquadraticcurvecommand/) \| [`TParsedQuadraticCurveShortcutCommand`](/api/type-aliases/tparsedquadraticcurveshortcutcommand/) \| [`TParsedArcCommand`](/api/type-aliases/tparsedarccommand/) -Defined in: [src/util/path/typedefs.ts:266](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L266) +Defined in: [src/util/path/typedefs.ts:266](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L266) Any old valid SVG path command diff --git a/src/content/docs/api/type-aliases/TComplexParsedCommandType.md b/src/content/docs/api/type-aliases/TComplexParsedCommandType.md index 62f232c2..50f5fb2c 100644 --- a/src/content/docs/api/type-aliases/TComplexParsedCommandType.md +++ b/src/content/docs/api/type-aliases/TComplexParsedCommandType.md @@ -7,4 +7,4 @@ title: "TComplexParsedCommandType" > **TComplexParsedCommandType** = `"M"` \| `"L"` \| `"C"` \| `"Q"` \| `"Z"` \| `"z"` \| `"m"` \| `"l"` \| `"h"` \| `"v"` \| `"c"` \| `"s"` \| `"q"` \| `"t"` \| `"a"` \| `"H"` \| `"V"` \| `"S"` \| `"T"` \| `"A"` -Defined in: [src/util/path/typedefs.ts:296](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L296) +Defined in: [src/util/path/typedefs.ts:296](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L296) diff --git a/src/content/docs/api/type-aliases/TComplexPathData.md b/src/content/docs/api/type-aliases/TComplexPathData.md index 1e9b5335..d7b76615 100644 --- a/src/content/docs/api/type-aliases/TComplexPathData.md +++ b/src/content/docs/api/type-aliases/TComplexPathData.md @@ -7,6 +7,6 @@ title: "TComplexPathData" > **TComplexPathData** = [`TComplexParsedCommand`](/api/type-aliases/tcomplexparsedcommand/)[] -Defined in: [src/util/path/typedefs.ts:281](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L281) +Defined in: [src/util/path/typedefs.ts:281](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L281) A series of path commands diff --git a/src/content/docs/api/type-aliases/TCornerPoint.md b/src/content/docs/api/type-aliases/TCornerPoint.md index 21247097..a153b0fa 100644 --- a/src/content/docs/api/type-aliases/TCornerPoint.md +++ b/src/content/docs/api/type-aliases/TCornerPoint.md @@ -7,7 +7,7 @@ title: "TCornerPoint" > **TCornerPoint** = `object` -Defined in: [src/typedefs.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L82) +Defined in: [src/typedefs.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L82) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/typedefs.ts:82](https://github.com/fabricjs/fabric.js/blob/22fd > **bl**: [`Point`](/api/classes/point/) -Defined in: [src/typedefs.ts:85](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L85) +Defined in: [src/typedefs.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L85) *** @@ -23,7 +23,7 @@ Defined in: [src/typedefs.ts:85](https://github.com/fabricjs/fabric.js/blob/22fd > **br**: [`Point`](/api/classes/point/) -Defined in: [src/typedefs.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L86) +Defined in: [src/typedefs.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L86) *** @@ -31,7 +31,7 @@ Defined in: [src/typedefs.ts:86](https://github.com/fabricjs/fabric.js/blob/22fd > **tl**: [`Point`](/api/classes/point/) -Defined in: [src/typedefs.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L83) +Defined in: [src/typedefs.ts:83](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L83) *** @@ -39,4 +39,4 @@ Defined in: [src/typedefs.ts:83](https://github.com/fabricjs/fabric.js/blob/22fd > **tr**: [`Point`](/api/classes/point/) -Defined in: [src/typedefs.ts:84](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L84) +Defined in: [src/typedefs.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L84) diff --git a/src/content/docs/api/type-aliases/TCrossOrigin.md b/src/content/docs/api/type-aliases/TCrossOrigin.md index 082fce93..42c5f9b2 100644 --- a/src/content/docs/api/type-aliases/TCrossOrigin.md +++ b/src/content/docs/api/type-aliases/TCrossOrigin.md @@ -7,7 +7,7 @@ title: "TCrossOrigin" > **TCrossOrigin** = `""` \| `"anonymous"` \| `"use-credentials"` \| `null` -Defined in: [src/typedefs.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L77) +Defined in: [src/typedefs.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L77) An invalid keyword and an empty string will be handled as the `anonymous` keyword. diff --git a/src/content/docs/api/type-aliases/TCubicCurveCommand.md b/src/content/docs/api/type-aliases/TCubicCurveCommand.md index fa6a42b1..a49e847f 100644 --- a/src/content/docs/api/type-aliases/TCubicCurveCommand.md +++ b/src/content/docs/api/type-aliases/TCubicCurveCommand.md @@ -7,4 +7,4 @@ title: "TCubicCurveCommand" > **TCubicCurveCommand** = `TCommand7`\<[`TParsedCubicCurveCommand`](/api/type-aliases/tparsedcubiccurvecommand/)\> -Defined in: [src/util/path/typedefs.ts:168](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L168) +Defined in: [src/util/path/typedefs.ts:168](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L168) diff --git a/src/content/docs/api/type-aliases/TCubicCurveShortcutCommand.md b/src/content/docs/api/type-aliases/TCubicCurveShortcutCommand.md index b8672805..05e2235e 100644 --- a/src/content/docs/api/type-aliases/TCubicCurveShortcutCommand.md +++ b/src/content/docs/api/type-aliases/TCubicCurveShortcutCommand.md @@ -7,4 +7,4 @@ title: "TCubicCurveShortcutCommand" > **TCubicCurveShortcutCommand** = `TCommand5`\<[`TParsedCubicCurveShortcutCommand`](/api/type-aliases/tparsedcubiccurveshortcutcommand/)\> -Defined in: [src/util/path/typedefs.ts:188](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L188) +Defined in: [src/util/path/typedefs.ts:188](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L188) diff --git a/src/content/docs/api/type-aliases/TCurveInfo.md b/src/content/docs/api/type-aliases/TCurveInfo.md index 1eafdbaa..f88a647b 100644 --- a/src/content/docs/api/type-aliases/TCurveInfo.md +++ b/src/content/docs/api/type-aliases/TCurveInfo.md @@ -7,7 +7,7 @@ title: "TCurveInfo" > **TCurveInfo**\<`C`\> = [`TPathSegmentInfoCommon`](/api/type-aliases/tpathsegmentinfocommon/)\<`C`\> & `object` -Defined in: [src/util/path/typedefs.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L11) +Defined in: [src/util/path/typedefs.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L11) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/TDataUrlOptions.md b/src/content/docs/api/type-aliases/TDataUrlOptions.md index a0ba42fb..ee42b883 100644 --- a/src/content/docs/api/type-aliases/TDataUrlOptions.md +++ b/src/content/docs/api/type-aliases/TDataUrlOptions.md @@ -7,7 +7,7 @@ title: "TDataUrlOptions" > **TDataUrlOptions**\<`T`\> = [`TToCanvasElementOptions`](/api/type-aliases/ttocanvaselementoptions/)\<`T`\> & `object` -Defined in: [src/typedefs.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L116) +Defined in: [src/typedefs.ts:116](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L116) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/TDegree.md b/src/content/docs/api/type-aliases/TDegree.md index 4b8b1bbc..d7709ebb 100644 --- a/src/content/docs/api/type-aliases/TDegree.md +++ b/src/content/docs/api/type-aliases/TDegree.md @@ -7,4 +7,4 @@ title: "TDegree" > **TDegree** = `Nominal`\<`number`, `Degree`\> -Defined in: [src/typedefs.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L25) +Defined in: [src/typedefs.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L25) diff --git a/src/content/docs/api/type-aliases/TEndPathInfo.md b/src/content/docs/api/type-aliases/TEndPathInfo.md index 0ad85efc..e82e2ba6 100644 --- a/src/content/docs/api/type-aliases/TEndPathInfo.md +++ b/src/content/docs/api/type-aliases/TEndPathInfo.md @@ -7,7 +7,7 @@ title: "TEndPathInfo" > **TEndPathInfo** = [`TPathSegmentInfoCommon`](/api/type-aliases/tpathsegmentinfocommon/)\<`"Z"`\> & `object` -Defined in: [src/util/path/typedefs.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L28) +Defined in: [src/util/path/typedefs.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L28) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/TEventsExtraData.md b/src/content/docs/api/type-aliases/TEventsExtraData.md index 82023cba..fed42d23 100644 --- a/src/content/docs/api/type-aliases/TEventsExtraData.md +++ b/src/content/docs/api/type-aliases/TEventsExtraData.md @@ -7,4 +7,4 @@ title: "TEventsExtraData" > **TEventsExtraData** = `Record`\<`PropertyKey`, `Record`\<`PropertyKey`, `never`\>\> & `Record`\<`"down"`, \{ `alreadySelected`: `boolean`; \}\> -Defined in: [src/EventTypeDefs.ts:355](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L355) +Defined in: [src/EventTypeDefs.ts:359](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L359) diff --git a/src/content/docs/api/type-aliases/TFabricObjectProps.md b/src/content/docs/api/type-aliases/TFabricObjectProps.md index 2cd81d85..9b4af147 100644 --- a/src/content/docs/api/type-aliases/TFabricObjectProps.md +++ b/src/content/docs/api/type-aliases/TFabricObjectProps.md @@ -7,4 +7,4 @@ title: "TFabricObjectProps" > **TFabricObjectProps** = [`TOptions`](/api/type-aliases/toptions/)\<[`FabricObjectProps`](/api/interfaces/fabricobjectprops/)\> -Defined in: [src/shapes/Object/types/index.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Object/types/index.ts#L7) +Defined in: [src/shapes/Object/types/index.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Object/types/index.ts#L7) diff --git a/src/content/docs/api/type-aliases/TFiller.md b/src/content/docs/api/type-aliases/TFiller.md index 23f8369c..46a6e8ed 100644 --- a/src/content/docs/api/type-aliases/TFiller.md +++ b/src/content/docs/api/type-aliases/TFiller.md @@ -7,4 +7,4 @@ title: "TFiller" > **TFiller** = [`Gradient`](/api/classes/gradient/)\<`"linear"`\> \| [`Gradient`](/api/classes/gradient/)\<`"radial"`\> \| [`Pattern`](/api/classes/pattern/) -Defined in: [src/typedefs.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L32) +Defined in: [src/typedefs.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L32) diff --git a/src/content/docs/api/type-aliases/THorizontalLineCommand.md b/src/content/docs/api/type-aliases/THorizontalLineCommand.md index 13037b41..43098277 100644 --- a/src/content/docs/api/type-aliases/THorizontalLineCommand.md +++ b/src/content/docs/api/type-aliases/THorizontalLineCommand.md @@ -7,4 +7,4 @@ title: "THorizontalLineCommand" > **THorizontalLineCommand** = `TCommand2`\<[`TParsedHorizontalLineCommand`](/api/type-aliases/tparsedhorizontallinecommand/)\> -Defined in: [src/util/path/typedefs.ts:128](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L128) +Defined in: [src/util/path/typedefs.ts:128](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L128) diff --git a/src/content/docs/api/type-aliases/TLineCommand.md b/src/content/docs/api/type-aliases/TLineCommand.md index 44c6bf28..0e9bb753 100644 --- a/src/content/docs/api/type-aliases/TLineCommand.md +++ b/src/content/docs/api/type-aliases/TLineCommand.md @@ -7,4 +7,4 @@ title: "TLineCommand" > **TLineCommand** = `TCommand3`\<[`TParsedLineCommand`](/api/type-aliases/tparsedlinecommand/)\> -Defined in: [src/util/path/typedefs.ts:120](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L120) +Defined in: [src/util/path/typedefs.ts:120](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L120) diff --git a/src/content/docs/api/type-aliases/TMat2D.md b/src/content/docs/api/type-aliases/TMat2D.md index ac3d9648..f5775f88 100644 --- a/src/content/docs/api/type-aliases/TMat2D.md +++ b/src/content/docs/api/type-aliases/TMat2D.md @@ -7,7 +7,7 @@ title: "TMat2D" > **TMat2D** = \[`number`, `number`, `number`, `number`, `number`, `number`\] -Defined in: [src/typedefs.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L64) +Defined in: [src/typedefs.ts:64](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L64) A transform matrix. Basically a matrix in the form diff --git a/src/content/docs/api/type-aliases/TMatColorMatrix.md b/src/content/docs/api/type-aliases/TMatColorMatrix.md index 61950361..c6d6250c 100644 --- a/src/content/docs/api/type-aliases/TMatColorMatrix.md +++ b/src/content/docs/api/type-aliases/TMatColorMatrix.md @@ -7,4 +7,4 @@ title: "TMatColorMatrix" > **TMatColorMatrix** = \[`number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`\] -Defined in: [src/filters/typedefs.ts:60](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L60) +Defined in: [src/filters/typedefs.ts:60](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L60) diff --git a/src/content/docs/api/type-aliases/TModificationEvents.md b/src/content/docs/api/type-aliases/TModificationEvents.md index d4320c75..3b780628 100644 --- a/src/content/docs/api/type-aliases/TModificationEvents.md +++ b/src/content/docs/api/type-aliases/TModificationEvents.md @@ -7,4 +7,4 @@ title: "TModificationEvents" > **TModificationEvents** = *typeof* `MOVING` \| *typeof* `SCALING` \| *typeof* `ROTATING` \| *typeof* `SKEWING` \| *typeof* `RESIZING` \| *typeof* `MODIFY_POLY` \| *typeof* `MODIFY_PATH` -Defined in: [src/EventTypeDefs.ts:121](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L121) +Defined in: [src/EventTypeDefs.ts:121](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L121) diff --git a/src/content/docs/api/type-aliases/TMoveToCommand.md b/src/content/docs/api/type-aliases/TMoveToCommand.md index 839e8a16..128015da 100644 --- a/src/content/docs/api/type-aliases/TMoveToCommand.md +++ b/src/content/docs/api/type-aliases/TMoveToCommand.md @@ -7,4 +7,4 @@ title: "TMoveToCommand" > **TMoveToCommand** = `TCommand3`\<[`TParsedMoveToCommand`](/api/type-aliases/tparsedmovetocommand/)\> -Defined in: [src/util/path/typedefs.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L112) +Defined in: [src/util/path/typedefs.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L112) diff --git a/src/content/docs/api/type-aliases/TOptionalModifierKey.md b/src/content/docs/api/type-aliases/TOptionalModifierKey.md index 86eede24..d54ac86b 100644 --- a/src/content/docs/api/type-aliases/TOptionalModifierKey.md +++ b/src/content/docs/api/type-aliases/TOptionalModifierKey.md @@ -7,4 +7,4 @@ title: "TOptionalModifierKey" > **TOptionalModifierKey** = [`ModifierKey`](/api/type-aliases/modifierkey/) \| `null` \| `undefined` -Defined in: [src/EventTypeDefs.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L31) +Defined in: [src/EventTypeDefs.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L31) diff --git a/src/content/docs/api/type-aliases/TOptions.md b/src/content/docs/api/type-aliases/TOptions.md index 297063de..bfcd9c43 100644 --- a/src/content/docs/api/type-aliases/TOptions.md +++ b/src/content/docs/api/type-aliases/TOptions.md @@ -7,7 +7,7 @@ title: "TOptions" > **TOptions**\<`T`\> = `Partial`\<`T`\> & `Record`\<`string`, `any`\> -Defined in: [src/typedefs.ts:132](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L132) +Defined in: [src/typedefs.ts:132](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L132) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/TOriginX.md b/src/content/docs/api/type-aliases/TOriginX.md index 2dae8114..341c76aa 100644 --- a/src/content/docs/api/type-aliases/TOriginX.md +++ b/src/content/docs/api/type-aliases/TOriginX.md @@ -7,4 +7,4 @@ title: "TOriginX" > **TOriginX** = `"center"` \| `"left"` \| `"right"` \| `number` -Defined in: [src/typedefs.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L79) +Defined in: [src/typedefs.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L79) diff --git a/src/content/docs/api/type-aliases/TOriginY.md b/src/content/docs/api/type-aliases/TOriginY.md index 2a82818f..8de06870 100644 --- a/src/content/docs/api/type-aliases/TOriginY.md +++ b/src/content/docs/api/type-aliases/TOriginY.md @@ -7,4 +7,4 @@ title: "TOriginY" > **TOriginY** = `"center"` \| `"top"` \| `"bottom"` \| `number` -Defined in: [src/typedefs.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L80) +Defined in: [src/typedefs.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L80) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteArcCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteArcCommand.md index a83303b3..482122a6 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteArcCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteArcCommand.md @@ -7,4 +7,4 @@ title: "TParsedAbsoluteArcCommand" > **TParsedAbsoluteArcCommand** = \[`"A"`, `number`, `number`, [`TRadian`](/api/type-aliases/tradian/), `0` \| `1`, `0` \| `1`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:228](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L228) +Defined in: [src/util/path/typedefs.ts:228](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L228) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteClosePathCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteClosePathCommand.md index 31a6ed79..4e7c91f0 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteClosePathCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteClosePathCommand.md @@ -7,4 +7,4 @@ title: "TParsedAbsoluteClosePathCommand" > **TParsedAbsoluteClosePathCommand** = \[`"Z"`\] -Defined in: [src/util/path/typedefs.ts:138](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L138) +Defined in: [src/util/path/typedefs.ts:138](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L138) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteCubicCurveCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteCubicCurveCommand.md index 509dd456..c9de5ce6 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteCubicCurveCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteCubicCurveCommand.md @@ -7,4 +7,4 @@ title: "TParsedAbsoluteCubicCurveCommand" > **TParsedAbsoluteCubicCurveCommand** = \[`"C"`, `number`, `number`, `number`, `number`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:146](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L146) +Defined in: [src/util/path/typedefs.ts:146](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L146) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteCubicCurveShortcutCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteCubicCurveShortcutCommand.md index f3ec1ec2..59a81cdc 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteCubicCurveShortcutCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteCubicCurveShortcutCommand.md @@ -7,4 +7,4 @@ title: "TParsedAbsoluteCubicCurveShortcutCommand" > **TParsedAbsoluteCubicCurveShortcutCommand** = \[`"S"`, `number`, `number`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:170](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L170) +Defined in: [src/util/path/typedefs.ts:170](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L170) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteHorizontalLineCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteHorizontalLineCommand.md index ee69cdf6..fdde3aa7 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteHorizontalLineCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteHorizontalLineCommand.md @@ -7,4 +7,4 @@ title: "TParsedAbsoluteHorizontalLineCommand" > **TParsedAbsoluteHorizontalLineCommand** = \[`"H"`, `number`\] -Defined in: [src/util/path/typedefs.ts:122](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L122) +Defined in: [src/util/path/typedefs.ts:122](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L122) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteLineCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteLineCommand.md index 83d45a30..d812e989 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteLineCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteLineCommand.md @@ -7,4 +7,4 @@ title: "TParsedAbsoluteLineCommand" > **TParsedAbsoluteLineCommand** = \[`"L"`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:114](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L114) +Defined in: [src/util/path/typedefs.ts:114](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L114) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteMoveToCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteMoveToCommand.md index e4fa5364..ed579649 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteMoveToCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteMoveToCommand.md @@ -7,7 +7,7 @@ title: "TParsedAbsoluteMoveToCommand" > **TParsedAbsoluteMoveToCommand** = \[`"M"`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:102](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L102) +Defined in: [src/util/path/typedefs.ts:102](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L102) Begin parsed SVG path commands Read about commands at [https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths\|MDN](https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths|MDN) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteQuadraticCurveCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteQuadraticCurveCommand.md index 9fda6dba..26ed0c10 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteQuadraticCurveCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteQuadraticCurveCommand.md @@ -7,4 +7,4 @@ title: "TParsedAbsoluteQuadraticCurveCommand" > **TParsedAbsoluteQuadraticCurveCommand** = \[`"Q"`, `number`, `number`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:191](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L191) +Defined in: [src/util/path/typedefs.ts:191](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L191) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteQuadraticCurveShortcutCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteQuadraticCurveShortcutCommand.md index 0287cd0f..3a85e4c5 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteQuadraticCurveShortcutCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteQuadraticCurveShortcutCommand.md @@ -7,4 +7,4 @@ title: "TParsedAbsoluteQuadraticCurveShortcutCommand" > **TParsedAbsoluteQuadraticCurveShortcutCommand** = \[`"T"`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:211](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L211) +Defined in: [src/util/path/typedefs.ts:211](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L211) diff --git a/src/content/docs/api/type-aliases/TParsedAbsoluteVerticalLineCommand.md b/src/content/docs/api/type-aliases/TParsedAbsoluteVerticalLineCommand.md index f515767e..36601840 100644 --- a/src/content/docs/api/type-aliases/TParsedAbsoluteVerticalLineCommand.md +++ b/src/content/docs/api/type-aliases/TParsedAbsoluteVerticalLineCommand.md @@ -7,4 +7,4 @@ title: "TParsedAbsoluteVerticalLineCommand" > **TParsedAbsoluteVerticalLineCommand** = \[`"V"`, `number`\] -Defined in: [src/util/path/typedefs.ts:130](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L130) +Defined in: [src/util/path/typedefs.ts:130](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L130) diff --git a/src/content/docs/api/type-aliases/TParsedArcCommand.md b/src/content/docs/api/type-aliases/TParsedArcCommand.md index 77efd684..d8839ce4 100644 --- a/src/content/docs/api/type-aliases/TParsedArcCommand.md +++ b/src/content/docs/api/type-aliases/TParsedArcCommand.md @@ -7,4 +7,4 @@ title: "TParsedArcCommand" > **TParsedArcCommand** = [`TParsedAbsoluteArcCommand`](/api/type-aliases/tparsedabsolutearccommand/) \| [`TParsedRelativeArcCommand`](/api/type-aliases/tparsedrelativearccommand/) -Defined in: [src/util/path/typedefs.ts:249](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L249) +Defined in: [src/util/path/typedefs.ts:249](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L249) diff --git a/src/content/docs/api/type-aliases/TParsedClosePathCommand.md b/src/content/docs/api/type-aliases/TParsedClosePathCommand.md index a1b773be..0be84747 100644 --- a/src/content/docs/api/type-aliases/TParsedClosePathCommand.md +++ b/src/content/docs/api/type-aliases/TParsedClosePathCommand.md @@ -7,4 +7,4 @@ title: "TParsedClosePathCommand" > **TParsedClosePathCommand** = [`TParsedAbsoluteClosePathCommand`](/api/type-aliases/tparsedabsoluteclosepathcommand/) \| [`TParsedRelativeClosePathCommand`](/api/type-aliases/tparsedrelativeclosepathcommand/) -Defined in: [src/util/path/typedefs.ts:140](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L140) +Defined in: [src/util/path/typedefs.ts:140](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L140) diff --git a/src/content/docs/api/type-aliases/TParsedCommand.md b/src/content/docs/api/type-aliases/TParsedCommand.md index 469aad63..fb9ac403 100644 --- a/src/content/docs/api/type-aliases/TParsedCommand.md +++ b/src/content/docs/api/type-aliases/TParsedCommand.md @@ -7,6 +7,6 @@ title: "TParsedCommand" > **TParsedCommand** = \[`string`\] \| \[`string`, `number`\] \| \[`string`, `number`, `number`\] \| \[`string`, `number`, `number`, `number`\] \| \[`string`, `number`, `number`, `number`, `number`\] \| \[`string`, `number`, `number`, `number`, `number`, `number`\] \| \[`string`, `number`, `number`, `number`, `number`, `number`, `number`\] \| \[`string`, `number`, `number`, `number`, `number`, `number`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:51](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L51) +Defined in: [src/util/path/typedefs.ts:51](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L51) A parsed command of any length (even impossible ones) diff --git a/src/content/docs/api/type-aliases/TParsedCubicCurveCommand.md b/src/content/docs/api/type-aliases/TParsedCubicCurveCommand.md index d9d983a4..c5b24717 100644 --- a/src/content/docs/api/type-aliases/TParsedCubicCurveCommand.md +++ b/src/content/docs/api/type-aliases/TParsedCubicCurveCommand.md @@ -7,4 +7,4 @@ title: "TParsedCubicCurveCommand" > **TParsedCubicCurveCommand** = [`TParsedAbsoluteCubicCurveCommand`](/api/type-aliases/tparsedabsolutecubiccurvecommand/) \| [`TParsedRelativeCubicCurveCommand`](/api/type-aliases/tparsedrelativecubiccurvecommand/) -Defined in: [src/util/path/typedefs.ts:164](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L164) +Defined in: [src/util/path/typedefs.ts:164](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L164) diff --git a/src/content/docs/api/type-aliases/TParsedCubicCurveShortcutCommand.md b/src/content/docs/api/type-aliases/TParsedCubicCurveShortcutCommand.md index b5063a3b..ab44596c 100644 --- a/src/content/docs/api/type-aliases/TParsedCubicCurveShortcutCommand.md +++ b/src/content/docs/api/type-aliases/TParsedCubicCurveShortcutCommand.md @@ -7,4 +7,4 @@ title: "TParsedCubicCurveShortcutCommand" > **TParsedCubicCurveShortcutCommand** = [`TParsedAbsoluteCubicCurveShortcutCommand`](/api/type-aliases/tparsedabsolutecubiccurveshortcutcommand/) \| [`TParsedRelativeCubicCurveShortcutCommand`](/api/type-aliases/tparsedrelativecubiccurveshortcutcommand/) -Defined in: [src/util/path/typedefs.ts:184](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L184) +Defined in: [src/util/path/typedefs.ts:184](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L184) diff --git a/src/content/docs/api/type-aliases/TParsedHorizontalLineCommand.md b/src/content/docs/api/type-aliases/TParsedHorizontalLineCommand.md index fd7180a9..6956100b 100644 --- a/src/content/docs/api/type-aliases/TParsedHorizontalLineCommand.md +++ b/src/content/docs/api/type-aliases/TParsedHorizontalLineCommand.md @@ -7,4 +7,4 @@ title: "TParsedHorizontalLineCommand" > **TParsedHorizontalLineCommand** = [`TParsedAbsoluteHorizontalLineCommand`](/api/type-aliases/tparsedabsolutehorizontallinecommand/) \| [`TParsedRelativeHorizontalLineCommand`](/api/type-aliases/tparsedrelativehorizontallinecommand/) -Defined in: [src/util/path/typedefs.ts:124](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L124) +Defined in: [src/util/path/typedefs.ts:124](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L124) diff --git a/src/content/docs/api/type-aliases/TParsedLineCommand.md b/src/content/docs/api/type-aliases/TParsedLineCommand.md index f6a951c6..670f735e 100644 --- a/src/content/docs/api/type-aliases/TParsedLineCommand.md +++ b/src/content/docs/api/type-aliases/TParsedLineCommand.md @@ -7,4 +7,4 @@ title: "TParsedLineCommand" > **TParsedLineCommand** = [`TParsedAbsoluteLineCommand`](/api/type-aliases/tparsedabsolutelinecommand/) \| [`TParsedRelativeLineCommand`](/api/type-aliases/tparsedrelativelinecommand/) -Defined in: [src/util/path/typedefs.ts:116](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L116) +Defined in: [src/util/path/typedefs.ts:116](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L116) diff --git a/src/content/docs/api/type-aliases/TParsedMoveToCommand.md b/src/content/docs/api/type-aliases/TParsedMoveToCommand.md index e4095d6f..20f5d045 100644 --- a/src/content/docs/api/type-aliases/TParsedMoveToCommand.md +++ b/src/content/docs/api/type-aliases/TParsedMoveToCommand.md @@ -7,4 +7,4 @@ title: "TParsedMoveToCommand" > **TParsedMoveToCommand** = [`TParsedAbsoluteMoveToCommand`](/api/type-aliases/tparsedabsolutemovetocommand/) \| [`TParsedRelativeMoveToCommand`](/api/type-aliases/tparsedrelativemovetocommand/) -Defined in: [src/util/path/typedefs.ts:108](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L108) +Defined in: [src/util/path/typedefs.ts:108](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L108) diff --git a/src/content/docs/api/type-aliases/TParsedQuadraticCurveCommand.md b/src/content/docs/api/type-aliases/TParsedQuadraticCurveCommand.md index 776d489d..aecdcd5b 100644 --- a/src/content/docs/api/type-aliases/TParsedQuadraticCurveCommand.md +++ b/src/content/docs/api/type-aliases/TParsedQuadraticCurveCommand.md @@ -7,4 +7,4 @@ title: "TParsedQuadraticCurveCommand" > **TParsedQuadraticCurveCommand** = [`TParsedAbsoluteQuadraticCurveCommand`](/api/type-aliases/tparsedabsolutequadraticcurvecommand/) \| [`TParsedRelativeQuadraticCurveCommand`](/api/type-aliases/tparsedrelativequadraticcurvecommand/) -Defined in: [src/util/path/typedefs.ts:205](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L205) +Defined in: [src/util/path/typedefs.ts:205](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L205) diff --git a/src/content/docs/api/type-aliases/TParsedQuadraticCurveShortcutCommand.md b/src/content/docs/api/type-aliases/TParsedQuadraticCurveShortcutCommand.md index bab0c4c3..9ba244f9 100644 --- a/src/content/docs/api/type-aliases/TParsedQuadraticCurveShortcutCommand.md +++ b/src/content/docs/api/type-aliases/TParsedQuadraticCurveShortcutCommand.md @@ -7,4 +7,4 @@ title: "TParsedQuadraticCurveShortcutCommand" > **TParsedQuadraticCurveShortcutCommand** = [`TParsedAbsoluteQuadraticCurveShortcutCommand`](/api/type-aliases/tparsedabsolutequadraticcurveshortcutcommand/) \| [`TParsedRelativeQuadraticCurveShortcutCommand`](/api/type-aliases/tparsedrelativequadraticcurveshortcutcommand/) -Defined in: [src/util/path/typedefs.ts:221](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L221) +Defined in: [src/util/path/typedefs.ts:221](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L221) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeArcCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeArcCommand.md index 775f1f18..499d09f2 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeArcCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeArcCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeArcCommand" > **TParsedRelativeArcCommand** = \[`"a"`, `number`, `number`, [`TRadian`](/api/type-aliases/tradian/), `0` \| `1`, `0` \| `1`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:238](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L238) +Defined in: [src/util/path/typedefs.ts:238](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L238) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeClosePathCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeClosePathCommand.md index 0d1f41b1..cea610f5 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeClosePathCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeClosePathCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeClosePathCommand" > **TParsedRelativeClosePathCommand** = \[`"z"`\] -Defined in: [src/util/path/typedefs.ts:139](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L139) +Defined in: [src/util/path/typedefs.ts:139](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L139) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeCubicCurveCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeCubicCurveCommand.md index 73237b7b..8ec9563a 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeCubicCurveCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeCubicCurveCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeCubicCurveCommand" > **TParsedRelativeCubicCurveCommand** = \[`"c"`, `number`, `number`, `number`, `number`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:155](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L155) +Defined in: [src/util/path/typedefs.ts:155](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L155) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeCubicCurveShortcutCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeCubicCurveShortcutCommand.md index b31e9a03..fb106719 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeCubicCurveShortcutCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeCubicCurveShortcutCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeCubicCurveShortcutCommand" > **TParsedRelativeCubicCurveShortcutCommand** = \[`"s"`, `number`, `number`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:177](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L177) +Defined in: [src/util/path/typedefs.ts:177](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L177) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeHorizontalLineCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeHorizontalLineCommand.md index f3defa6e..677fb58b 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeHorizontalLineCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeHorizontalLineCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeHorizontalLineCommand" > **TParsedRelativeHorizontalLineCommand** = \[`"h"`, `number`\] -Defined in: [src/util/path/typedefs.ts:123](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L123) +Defined in: [src/util/path/typedefs.ts:123](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L123) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeLineCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeLineCommand.md index eee34e0e..8a74553f 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeLineCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeLineCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeLineCommand" > **TParsedRelativeLineCommand** = \[`"l"`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:115](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L115) +Defined in: [src/util/path/typedefs.ts:115](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L115) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeMoveToCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeMoveToCommand.md index 98547f75..f903f27e 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeMoveToCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeMoveToCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeMoveToCommand" > **TParsedRelativeMoveToCommand** = \[`"m"`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:103](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L103) +Defined in: [src/util/path/typedefs.ts:103](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L103) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeQuadraticCurveCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeQuadraticCurveCommand.md index f573463a..bf8e96fa 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeQuadraticCurveCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeQuadraticCurveCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeQuadraticCurveCommand" > **TParsedRelativeQuadraticCurveCommand** = \[`"q"`, `number`, `number`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:198](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L198) +Defined in: [src/util/path/typedefs.ts:198](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L198) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeQuadraticCurveShortcutCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeQuadraticCurveShortcutCommand.md index af8c7b23..55cc1732 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeQuadraticCurveShortcutCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeQuadraticCurveShortcutCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeQuadraticCurveShortcutCommand" > **TParsedRelativeQuadraticCurveShortcutCommand** = \[`"t"`, `number`, `number`\] -Defined in: [src/util/path/typedefs.ts:216](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L216) +Defined in: [src/util/path/typedefs.ts:216](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L216) diff --git a/src/content/docs/api/type-aliases/TParsedRelativeVerticalLineCommand.md b/src/content/docs/api/type-aliases/TParsedRelativeVerticalLineCommand.md index 27f97f1b..0900d303 100644 --- a/src/content/docs/api/type-aliases/TParsedRelativeVerticalLineCommand.md +++ b/src/content/docs/api/type-aliases/TParsedRelativeVerticalLineCommand.md @@ -7,4 +7,4 @@ title: "TParsedRelativeVerticalLineCommand" > **TParsedRelativeVerticalLineCommand** = \[`"v"`, `number`\] -Defined in: [src/util/path/typedefs.ts:131](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L131) +Defined in: [src/util/path/typedefs.ts:131](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L131) diff --git a/src/content/docs/api/type-aliases/TParsedVerticalLineCommand.md b/src/content/docs/api/type-aliases/TParsedVerticalLineCommand.md index 4f7ce9e9..1e9d562e 100644 --- a/src/content/docs/api/type-aliases/TParsedVerticalLineCommand.md +++ b/src/content/docs/api/type-aliases/TParsedVerticalLineCommand.md @@ -7,4 +7,4 @@ title: "TParsedVerticalLineCommand" > **TParsedVerticalLineCommand** = [`TParsedAbsoluteVerticalLineCommand`](/api/type-aliases/tparsedabsoluteverticallinecommand/) \| [`TParsedRelativeVerticalLineCommand`](/api/type-aliases/tparsedrelativeverticallinecommand/) -Defined in: [src/util/path/typedefs.ts:132](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L132) +Defined in: [src/util/path/typedefs.ts:132](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L132) diff --git a/src/content/docs/api/type-aliases/TPathAlign.md b/src/content/docs/api/type-aliases/TPathAlign.md index dce2c9e7..5309e6ab 100644 --- a/src/content/docs/api/type-aliases/TPathAlign.md +++ b/src/content/docs/api/type-aliases/TPathAlign.md @@ -7,4 +7,4 @@ title: "TPathAlign" > **TPathAlign** = `"baseline"` \| `"center"` \| `"ascender"` \| `"descender"` -Defined in: [src/shapes/Text/Text.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L72) +Defined in: [src/shapes/Text/Text.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L73) diff --git a/src/content/docs/api/type-aliases/TPathSegmentCommandInfo.md b/src/content/docs/api/type-aliases/TPathSegmentCommandInfo.md index 8f1d7d24..643808c5 100644 --- a/src/content/docs/api/type-aliases/TPathSegmentCommandInfo.md +++ b/src/content/docs/api/type-aliases/TPathSegmentCommandInfo.md @@ -7,7 +7,7 @@ title: "TPathSegmentCommandInfo" > **TPathSegmentCommandInfo** = `object` -Defined in: [src/util/path/typedefs.ts:37](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L37) +Defined in: [src/util/path/typedefs.ts:37](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L37) Relevant info to calculate path length/points on path for each command type in a simplified parsed path @@ -18,7 +18,7 @@ for each command type in a simplified parsed path > **C**: [`TCurveInfo`](/api/type-aliases/tcurveinfo/)\<`"C"`\> -Defined in: [src/util/path/typedefs.ts:40](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L40) +Defined in: [src/util/path/typedefs.ts:40](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L40) *** @@ -26,7 +26,7 @@ Defined in: [src/util/path/typedefs.ts:40](https://github.com/fabricjs/fabric.js > **L**: [`TPathSegmentInfoCommon`](/api/type-aliases/tpathsegmentinfocommon/)\<`"L"`\> -Defined in: [src/util/path/typedefs.ts:39](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L39) +Defined in: [src/util/path/typedefs.ts:39](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L39) *** @@ -34,7 +34,7 @@ Defined in: [src/util/path/typedefs.ts:39](https://github.com/fabricjs/fabric.js > **M**: [`TPathSegmentInfoCommon`](/api/type-aliases/tpathsegmentinfocommon/)\<`"M"`\> -Defined in: [src/util/path/typedefs.ts:38](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L38) +Defined in: [src/util/path/typedefs.ts:38](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L38) *** @@ -42,7 +42,7 @@ Defined in: [src/util/path/typedefs.ts:38](https://github.com/fabricjs/fabric.js > **Q**: [`TCurveInfo`](/api/type-aliases/tcurveinfo/)\<`"Q"`\> -Defined in: [src/util/path/typedefs.ts:41](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L41) +Defined in: [src/util/path/typedefs.ts:41](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L41) *** @@ -50,4 +50,4 @@ Defined in: [src/util/path/typedefs.ts:41](https://github.com/fabricjs/fabric.js > **Z**: [`TEndPathInfo`](/api/type-aliases/tendpathinfo/) -Defined in: [src/util/path/typedefs.ts:42](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L42) +Defined in: [src/util/path/typedefs.ts:42](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L42) diff --git a/src/content/docs/api/type-aliases/TPathSegmentInfo.md b/src/content/docs/api/type-aliases/TPathSegmentInfo.md index ada15ce0..f620521e 100644 --- a/src/content/docs/api/type-aliases/TPathSegmentInfo.md +++ b/src/content/docs/api/type-aliases/TPathSegmentInfo.md @@ -7,4 +7,4 @@ title: "TPathSegmentInfo" > **TPathSegmentInfo** = [`TPathSegmentCommandInfo`](/api/type-aliases/tpathsegmentcommandinfo/)\[keyof [`TPathSegmentCommandInfo`](/api/type-aliases/tpathsegmentcommandinfo/)\] -Defined in: [src/util/path/typedefs.ts:45](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L45) +Defined in: [src/util/path/typedefs.ts:45](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L45) diff --git a/src/content/docs/api/type-aliases/TPathSegmentInfoCommon.md b/src/content/docs/api/type-aliases/TPathSegmentInfoCommon.md index c66ea932..7de9f5cb 100644 --- a/src/content/docs/api/type-aliases/TPathSegmentInfoCommon.md +++ b/src/content/docs/api/type-aliases/TPathSegmentInfoCommon.md @@ -7,7 +7,7 @@ title: "TPathSegmentInfoCommon" > **TPathSegmentInfoCommon**\<`C`\> = `object` -Defined in: [src/util/path/typedefs.ts:4](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L4) +Defined in: [src/util/path/typedefs.ts:4](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L4) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [src/util/path/typedefs.ts:4](https://github.com/fabricjs/fabric.js/ > `optional` **command**: `C` -Defined in: [src/util/path/typedefs.ts:7](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L7) +Defined in: [src/util/path/typedefs.ts:7](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L7) *** @@ -29,7 +29,7 @@ Defined in: [src/util/path/typedefs.ts:7](https://github.com/fabricjs/fabric.js/ > **length**: `number` -Defined in: [src/util/path/typedefs.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L8) +Defined in: [src/util/path/typedefs.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L8) *** @@ -37,7 +37,7 @@ Defined in: [src/util/path/typedefs.ts:8](https://github.com/fabricjs/fabric.js/ > **x**: `number` -Defined in: [src/util/path/typedefs.ts:5](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L5) +Defined in: [src/util/path/typedefs.ts:5](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L5) *** @@ -45,4 +45,4 @@ Defined in: [src/util/path/typedefs.ts:5](https://github.com/fabricjs/fabric.js/ > **y**: `number` -Defined in: [src/util/path/typedefs.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L6) +Defined in: [src/util/path/typedefs.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L6) diff --git a/src/content/docs/api/type-aliases/TPathSide.md b/src/content/docs/api/type-aliases/TPathSide.md index 5002286c..8ffaf102 100644 --- a/src/content/docs/api/type-aliases/TPathSide.md +++ b/src/content/docs/api/type-aliases/TPathSide.md @@ -7,4 +7,4 @@ title: "TPathSide" > **TPathSide** = `"left"` \| `"right"` -Defined in: [src/shapes/Text/Text.ts:70](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/Text.ts#L70) +Defined in: [src/shapes/Text/Text.ts:71](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/Text.ts#L71) diff --git a/src/content/docs/api/type-aliases/TPipelineResources.md b/src/content/docs/api/type-aliases/TPipelineResources.md index c6d73c5a..8164ad8a 100644 --- a/src/content/docs/api/type-aliases/TPipelineResources.md +++ b/src/content/docs/api/type-aliases/TPipelineResources.md @@ -7,7 +7,7 @@ title: "TPipelineResources" > **TPipelineResources** = `object` & `Record`\<`string`, `unknown`\> -Defined in: [src/filters/typedefs.ts:8](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L8) +Defined in: [src/filters/typedefs.ts:8](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L8) ## Type Declaration diff --git a/src/content/docs/api/type-aliases/TPointAngle.md b/src/content/docs/api/type-aliases/TPointAngle.md index cc81816a..3779d71d 100644 --- a/src/content/docs/api/type-aliases/TPointAngle.md +++ b/src/content/docs/api/type-aliases/TPointAngle.md @@ -7,7 +7,7 @@ title: "TPointAngle" > **TPointAngle** = [`XY`](/api/interfaces/xy/) & `object` -Defined in: [src/util/path/typedefs.ts:326](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L326) +Defined in: [src/util/path/typedefs.ts:326](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L326) A point (vector) and angle between the vector and x-axis diff --git a/src/content/docs/api/type-aliases/TPointerEvent.md b/src/content/docs/api/type-aliases/TPointerEvent.md index 1bf33d4c..07b1d951 100644 --- a/src/content/docs/api/type-aliases/TPointerEvent.md +++ b/src/content/docs/api/type-aliases/TPointerEvent.md @@ -7,4 +7,4 @@ title: "TPointerEvent" > **TPointerEvent** = `MouseEvent` \| `TouchEvent` \| `PointerEvent` -Defined in: [src/EventTypeDefs.ts:33](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L33) +Defined in: [src/EventTypeDefs.ts:33](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L33) diff --git a/src/content/docs/api/type-aliases/TPointerEventNames.md b/src/content/docs/api/type-aliases/TPointerEventNames.md index f169e701..a92056b4 100644 --- a/src/content/docs/api/type-aliases/TPointerEventNames.md +++ b/src/content/docs/api/type-aliases/TPointerEventNames.md @@ -7,4 +7,4 @@ title: "TPointerEventNames" > **TPointerEventNames** = `WithBeforeSuffix`\<`"down"`\> \| `WithBeforeSuffix`\<`"move"`\> \| `WithBeforeSuffix`\<`"up"`\> \| `"dblclick"` \| `"tripleclick"` \| `"wheel"` -Defined in: [src/EventTypeDefs.ts:277](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L277) +Defined in: [src/EventTypeDefs.ts:281](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L281) diff --git a/src/content/docs/api/type-aliases/TProgramCache.md b/src/content/docs/api/type-aliases/TProgramCache.md index 4df1b323..2c7c3822 100644 --- a/src/content/docs/api/type-aliases/TProgramCache.md +++ b/src/content/docs/api/type-aliases/TProgramCache.md @@ -7,4 +7,4 @@ title: "TProgramCache" > **TProgramCache** = `any` -Defined in: [src/filters/typedefs.ts:4](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L4) +Defined in: [src/filters/typedefs.ts:4](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L4) diff --git a/src/content/docs/api/type-aliases/TQuadraticCurveCommand.md b/src/content/docs/api/type-aliases/TQuadraticCurveCommand.md index 5e1b577b..be2d571a 100644 --- a/src/content/docs/api/type-aliases/TQuadraticCurveCommand.md +++ b/src/content/docs/api/type-aliases/TQuadraticCurveCommand.md @@ -7,4 +7,4 @@ title: "TQuadraticCurveCommand" > **TQuadraticCurveCommand** = `TCommand5`\<[`TParsedQuadraticCurveCommand`](/api/type-aliases/tparsedquadraticcurvecommand/)\> -Defined in: [src/util/path/typedefs.ts:209](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L209) +Defined in: [src/util/path/typedefs.ts:209](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L209) diff --git a/src/content/docs/api/type-aliases/TQuadraticCurveShortcutCommand.md b/src/content/docs/api/type-aliases/TQuadraticCurveShortcutCommand.md index b05b7866..ed171398 100644 --- a/src/content/docs/api/type-aliases/TQuadraticCurveShortcutCommand.md +++ b/src/content/docs/api/type-aliases/TQuadraticCurveShortcutCommand.md @@ -7,4 +7,4 @@ title: "TQuadraticCurveShortcutCommand" > **TQuadraticCurveShortcutCommand** = `TCommand3`\<[`TParsedQuadraticCurveShortcutCommand`](/api/type-aliases/tparsedquadraticcurveshortcutcommand/)\> -Defined in: [src/util/path/typedefs.ts:225](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L225) +Defined in: [src/util/path/typedefs.ts:225](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L225) diff --git a/src/content/docs/api/type-aliases/TRGBAColorSource.md b/src/content/docs/api/type-aliases/TRGBAColorSource.md index 26c47349..ce9241c0 100644 --- a/src/content/docs/api/type-aliases/TRGBAColorSource.md +++ b/src/content/docs/api/type-aliases/TRGBAColorSource.md @@ -7,6 +7,6 @@ title: "TRGBAColorSource" > **TRGBAColorSource** = \[`number`, `number`, `number`, `number`\] -Defined in: [src/color/typedefs.ts:11](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/typedefs.ts#L11) +Defined in: [src/color/typedefs.ts:11](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/typedefs.ts#L11) RGBA format diff --git a/src/content/docs/api/type-aliases/TRGBColorSource.md b/src/content/docs/api/type-aliases/TRGBColorSource.md index 7f18c0ab..0c869529 100644 --- a/src/content/docs/api/type-aliases/TRGBColorSource.md +++ b/src/content/docs/api/type-aliases/TRGBColorSource.md @@ -7,6 +7,6 @@ title: "TRGBColorSource" > **TRGBColorSource** = \[`number`, `number`, `number`\] -Defined in: [src/color/typedefs.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/color/typedefs.ts#L6) +Defined in: [src/color/typedefs.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/color/typedefs.ts#L6) RGB format diff --git a/src/content/docs/api/type-aliases/TRadian.md b/src/content/docs/api/type-aliases/TRadian.md index ff0a3888..f1c760b1 100644 --- a/src/content/docs/api/type-aliases/TRadian.md +++ b/src/content/docs/api/type-aliases/TRadian.md @@ -7,4 +7,4 @@ title: "TRadian" > **TRadian** = `Nominal`\<`number`, `Radian`\> -Defined in: [src/typedefs.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L26) +Defined in: [src/typedefs.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L26) diff --git a/src/content/docs/api/type-aliases/TRectBounds.md b/src/content/docs/api/type-aliases/TRectBounds.md index bc0b2a2b..3c743b5b 100644 --- a/src/content/docs/api/type-aliases/TRectBounds.md +++ b/src/content/docs/api/type-aliases/TRectBounds.md @@ -7,4 +7,4 @@ title: "TRectBounds" > **TRectBounds** = \[[`XY`](/api/interfaces/xy/), [`XY`](/api/interfaces/xy/)\] -Defined in: [src/typedefs.ts:104](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L104) +Defined in: [src/typedefs.ts:104](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L104) diff --git a/src/content/docs/api/type-aliases/TSVGExportOptions.md b/src/content/docs/api/type-aliases/TSVGExportOptions.md index 043b220d..47144f3c 100644 --- a/src/content/docs/api/type-aliases/TSVGExportOptions.md +++ b/src/content/docs/api/type-aliases/TSVGExportOptions.md @@ -7,7 +7,7 @@ title: "TSVGExportOptions" > **TSVGExportOptions** = `object` -Defined in: [src/canvas/StaticCanvas.ts:63](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L63) +Defined in: [src/canvas/StaticCanvas.ts:67](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L67) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/canvas/StaticCanvas.ts:63](https://github.com/fabricjs/fabric.j > `optional` **encoding**: `"UTF-8"` -Defined in: [src/canvas/StaticCanvas.ts:71](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L71) +Defined in: [src/canvas/StaticCanvas.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L75) *** @@ -23,7 +23,7 @@ Defined in: [src/canvas/StaticCanvas.ts:71](https://github.com/fabricjs/fabric.j > `optional` **height**: `string` -Defined in: [src/canvas/StaticCanvas.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L73) +Defined in: [src/canvas/StaticCanvas.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L77) *** @@ -31,7 +31,7 @@ Defined in: [src/canvas/StaticCanvas.ts:73](https://github.com/fabricjs/fabric.j > `optional` **reviver**: [`TSVGReviver`](/api/type-aliases/tsvgreviver/) -Defined in: [src/canvas/StaticCanvas.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L74) +Defined in: [src/canvas/StaticCanvas.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L78) *** @@ -39,7 +39,7 @@ Defined in: [src/canvas/StaticCanvas.ts:74](https://github.com/fabricjs/fabric.j > `optional` **suppressPreamble**: `boolean` -Defined in: [src/canvas/StaticCanvas.ts:64](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L64) +Defined in: [src/canvas/StaticCanvas.ts:68](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L68) *** @@ -47,7 +47,7 @@ Defined in: [src/canvas/StaticCanvas.ts:64](https://github.com/fabricjs/fabric.j > `optional` **viewBox**: `object` -Defined in: [src/canvas/StaticCanvas.ts:65](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L65) +Defined in: [src/canvas/StaticCanvas.ts:69](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L69) #### height @@ -71,4 +71,4 @@ Defined in: [src/canvas/StaticCanvas.ts:65](https://github.com/fabricjs/fabric.j > `optional` **width**: `string` -Defined in: [src/canvas/StaticCanvas.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/canvas/StaticCanvas.ts#L72) +Defined in: [src/canvas/StaticCanvas.ts:76](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/canvas/StaticCanvas.ts#L76) diff --git a/src/content/docs/api/type-aliases/TSVGReviver.md b/src/content/docs/api/type-aliases/TSVGReviver.md index 9a99e98f..ef7b93f4 100644 --- a/src/content/docs/api/type-aliases/TSVGReviver.md +++ b/src/content/docs/api/type-aliases/TSVGReviver.md @@ -7,7 +7,7 @@ title: "TSVGReviver" > **TSVGReviver** = (`markup`) => `string` -Defined in: [src/typedefs.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L89) +Defined in: [src/typedefs.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L89) ## Parameters diff --git a/src/content/docs/api/type-aliases/TSimpleParseCommandType.md b/src/content/docs/api/type-aliases/TSimpleParseCommandType.md index d317f559..c061adf4 100644 --- a/src/content/docs/api/type-aliases/TSimpleParseCommandType.md +++ b/src/content/docs/api/type-aliases/TSimpleParseCommandType.md @@ -7,4 +7,4 @@ title: "TSimpleParseCommandType" > **TSimpleParseCommandType** = `"L"` \| `"M"` \| `"C"` \| `"Q"` \| `"Z"` -Defined in: [src/util/path/typedefs.ts:294](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L294) +Defined in: [src/util/path/typedefs.ts:294](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L294) diff --git a/src/content/docs/api/type-aliases/TSimpleParsedCommand.md b/src/content/docs/api/type-aliases/TSimpleParsedCommand.md index a9cffa71..7d426538 100644 --- a/src/content/docs/api/type-aliases/TSimpleParsedCommand.md +++ b/src/content/docs/api/type-aliases/TSimpleParsedCommand.md @@ -7,6 +7,6 @@ title: "TSimpleParsedCommand" > **TSimpleParsedCommand** = [`TParsedAbsoluteMoveToCommand`](/api/type-aliases/tparsedabsolutemovetocommand/) \| [`TParsedAbsoluteLineCommand`](/api/type-aliases/tparsedabsolutelinecommand/) \| [`TParsedAbsoluteClosePathCommand`](/api/type-aliases/tparsedabsoluteclosepathcommand/) \| [`TParsedAbsoluteCubicCurveCommand`](/api/type-aliases/tparsedabsolutecubiccurvecommand/) \| [`TParsedAbsoluteQuadraticCurveCommand`](/api/type-aliases/tparsedabsolutequadraticcurvecommand/) -Defined in: [src/util/path/typedefs.ts:287](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L287) +Defined in: [src/util/path/typedefs.ts:287](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L287) Any SVG command that all Fabric functions can understand diff --git a/src/content/docs/api/type-aliases/TSimplePathData.md b/src/content/docs/api/type-aliases/TSimplePathData.md index 0822fd43..81beac93 100644 --- a/src/content/docs/api/type-aliases/TSimplePathData.md +++ b/src/content/docs/api/type-aliases/TSimplePathData.md @@ -7,6 +7,6 @@ title: "TSimplePathData" > **TSimplePathData** = [`TSimpleParsedCommand`](/api/type-aliases/tsimpleparsedcommand/)[] -Defined in: [src/util/path/typedefs.ts:321](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L321) +Defined in: [src/util/path/typedefs.ts:321](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L321) A series of simple paths diff --git a/src/content/docs/api/type-aliases/TSize.md b/src/content/docs/api/type-aliases/TSize.md index 606b93d0..b23700a0 100644 --- a/src/content/docs/api/type-aliases/TSize.md +++ b/src/content/docs/api/type-aliases/TSize.md @@ -7,7 +7,7 @@ title: "TSize" > **TSize** = `object` -Defined in: [src/typedefs.ts:34](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L34) +Defined in: [src/typedefs.ts:34](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L34) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/typedefs.ts:34](https://github.com/fabricjs/fabric.js/blob/22fd > **height**: `number` -Defined in: [src/typedefs.ts:36](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L36) +Defined in: [src/typedefs.ts:36](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L36) *** @@ -23,4 +23,4 @@ Defined in: [src/typedefs.ts:36](https://github.com/fabricjs/fabric.js/blob/22fd > **width**: `number` -Defined in: [src/typedefs.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L35) +Defined in: [src/typedefs.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L35) diff --git a/src/content/docs/api/type-aliases/TTextureCache.md b/src/content/docs/api/type-aliases/TTextureCache.md index 4ce65a44..0908862d 100644 --- a/src/content/docs/api/type-aliases/TTextureCache.md +++ b/src/content/docs/api/type-aliases/TTextureCache.md @@ -7,4 +7,4 @@ title: "TTextureCache" > **TTextureCache** = `Record`\<`string`, `WebGLTexture`\> -Defined in: [src/filters/typedefs.ts:6](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L6) +Defined in: [src/filters/typedefs.ts:6](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L6) diff --git a/src/content/docs/api/type-aliases/TToCanvasElementOptions.md b/src/content/docs/api/type-aliases/TToCanvasElementOptions.md index 4b9a0fd5..5eb051db 100644 --- a/src/content/docs/api/type-aliases/TToCanvasElementOptions.md +++ b/src/content/docs/api/type-aliases/TToCanvasElementOptions.md @@ -7,7 +7,7 @@ title: "TToCanvasElementOptions" > **TToCanvasElementOptions**\<`T`\> = `object` -Defined in: [src/typedefs.ts:106](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L106) +Defined in: [src/typedefs.ts:106](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L106) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [src/typedefs.ts:106](https://github.com/fabricjs/fabric.js/blob/22f > `optional` **filter**: (`object`) => `boolean` -Defined in: [src/typedefs.ts:113](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L113) +Defined in: [src/typedefs.ts:113](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L113) #### Parameters @@ -39,7 +39,7 @@ Defined in: [src/typedefs.ts:113](https://github.com/fabricjs/fabric.js/blob/22f > `optional` **height**: `number` -Defined in: [src/typedefs.ts:112](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L112) +Defined in: [src/typedefs.ts:112](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L112) *** @@ -47,7 +47,7 @@ Defined in: [src/typedefs.ts:112](https://github.com/fabricjs/fabric.js/blob/22f > `optional` **left**: `number` -Defined in: [src/typedefs.ts:109](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L109) +Defined in: [src/typedefs.ts:109](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L109) *** @@ -55,7 +55,7 @@ Defined in: [src/typedefs.ts:109](https://github.com/fabricjs/fabric.js/blob/22f > `optional` **top**: `number` -Defined in: [src/typedefs.ts:110](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L110) +Defined in: [src/typedefs.ts:110](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L110) *** @@ -63,4 +63,4 @@ Defined in: [src/typedefs.ts:110](https://github.com/fabricjs/fabric.js/blob/22f > `optional` **width**: `number` -Defined in: [src/typedefs.ts:111](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L111) +Defined in: [src/typedefs.ts:111](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L111) diff --git a/src/content/docs/api/type-aliases/TValidToObjectMethod.md b/src/content/docs/api/type-aliases/TValidToObjectMethod.md index 5d8ab2b7..c104d527 100644 --- a/src/content/docs/api/type-aliases/TValidToObjectMethod.md +++ b/src/content/docs/api/type-aliases/TValidToObjectMethod.md @@ -7,4 +7,4 @@ title: "TValidToObjectMethod" > **TValidToObjectMethod** = `"toDatalessObject"` \| `"toObject"` -Defined in: [src/typedefs.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/typedefs.ts#L91) +Defined in: [src/typedefs.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/typedefs.ts#L91) diff --git a/src/content/docs/api/type-aliases/TVerticalLineCommand.md b/src/content/docs/api/type-aliases/TVerticalLineCommand.md index bc193480..8af99504 100644 --- a/src/content/docs/api/type-aliases/TVerticalLineCommand.md +++ b/src/content/docs/api/type-aliases/TVerticalLineCommand.md @@ -7,4 +7,4 @@ title: "TVerticalLineCommand" > **TVerticalLineCommand** = `TCommand2`\<[`TParsedVerticalLineCommand`](/api/type-aliases/tparsedverticallinecommand/)\> -Defined in: [src/util/path/typedefs.ts:136](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/path/typedefs.ts#L136) +Defined in: [src/util/path/typedefs.ts:136](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/path/typedefs.ts#L136) diff --git a/src/content/docs/api/type-aliases/TWebGLAttributeLocationMap.md b/src/content/docs/api/type-aliases/TWebGLAttributeLocationMap.md index 597caba6..c30e8247 100644 --- a/src/content/docs/api/type-aliases/TWebGLAttributeLocationMap.md +++ b/src/content/docs/api/type-aliases/TWebGLAttributeLocationMap.md @@ -7,4 +7,4 @@ title: "TWebGLAttributeLocationMap" > **TWebGLAttributeLocationMap** = `Record`\<`string`, `number`\> -Defined in: [src/filters/typedefs.ts:52](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L52) +Defined in: [src/filters/typedefs.ts:52](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L52) diff --git a/src/content/docs/api/type-aliases/TWebGLPipelineState.md b/src/content/docs/api/type-aliases/TWebGLPipelineState.md index 4224b2a4..599a66dc 100644 --- a/src/content/docs/api/type-aliases/TWebGLPipelineState.md +++ b/src/content/docs/api/type-aliases/TWebGLPipelineState.md @@ -7,7 +7,7 @@ title: "TWebGLPipelineState" > **TWebGLPipelineState** = `object` -Defined in: [src/filters/typedefs.ts:15](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L15) +Defined in: [src/filters/typedefs.ts:15](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L15) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/filters/typedefs.ts:15](https://github.com/fabricjs/fabric.js/b > **aPosition**: `Float32Array` -Defined in: [src/filters/typedefs.ts:29](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L29) +Defined in: [src/filters/typedefs.ts:29](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L29) *** @@ -23,7 +23,7 @@ Defined in: [src/filters/typedefs.ts:29](https://github.com/fabricjs/fabric.js/b > **context**: `WebGLRenderingContext` -Defined in: [src/filters/typedefs.ts:23](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L23) +Defined in: [src/filters/typedefs.ts:23](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L23) *** @@ -31,7 +31,7 @@ Defined in: [src/filters/typedefs.ts:23](https://github.com/fabricjs/fabric.js/b > **destinationHeight**: `number` -Defined in: [src/filters/typedefs.ts:22](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L22) +Defined in: [src/filters/typedefs.ts:22](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L22) *** @@ -39,7 +39,7 @@ Defined in: [src/filters/typedefs.ts:22](https://github.com/fabricjs/fabric.js/b > **destinationWidth**: `number` -Defined in: [src/filters/typedefs.ts:21](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L21) +Defined in: [src/filters/typedefs.ts:21](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L21) *** @@ -47,7 +47,7 @@ Defined in: [src/filters/typedefs.ts:21](https://github.com/fabricjs/fabric.js/b > **filterBackend**: [`WebGLFilterBackend`](/api/classes/webglfilterbackend/) -Defined in: [src/filters/typedefs.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L16) +Defined in: [src/filters/typedefs.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L16) *** @@ -55,7 +55,7 @@ Defined in: [src/filters/typedefs.ts:16](https://github.com/fabricjs/fabric.js/b > **originalHeight**: `number` -Defined in: [src/filters/typedefs.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L18) +Defined in: [src/filters/typedefs.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L18) *** @@ -63,7 +63,7 @@ Defined in: [src/filters/typedefs.ts:18](https://github.com/fabricjs/fabric.js/b > **originalTexture**: `WebGLTexture` -Defined in: [src/filters/typedefs.ts:26](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L26) +Defined in: [src/filters/typedefs.ts:26](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L26) *** @@ -71,7 +71,7 @@ Defined in: [src/filters/typedefs.ts:26](https://github.com/fabricjs/fabric.js/b > **originalWidth**: `number` -Defined in: [src/filters/typedefs.ts:17](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L17) +Defined in: [src/filters/typedefs.ts:17](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L17) *** @@ -79,7 +79,7 @@ Defined in: [src/filters/typedefs.ts:17](https://github.com/fabricjs/fabric.js/b > **pass**: `number` -Defined in: [src/filters/typedefs.ts:31](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L31) +Defined in: [src/filters/typedefs.ts:31](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L31) *** @@ -87,7 +87,7 @@ Defined in: [src/filters/typedefs.ts:31](https://github.com/fabricjs/fabric.js/b > **passes**: `number` -Defined in: [src/filters/typedefs.ts:27](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L27) +Defined in: [src/filters/typedefs.ts:27](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L27) *** @@ -95,7 +95,7 @@ Defined in: [src/filters/typedefs.ts:27](https://github.com/fabricjs/fabric.js/b > **programCache**: [`TProgramCache`](/api/type-aliases/tprogramcache/) -Defined in: [src/filters/typedefs.ts:30](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L30) +Defined in: [src/filters/typedefs.ts:30](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L30) *** @@ -103,7 +103,7 @@ Defined in: [src/filters/typedefs.ts:30](https://github.com/fabricjs/fabric.js/b > **sourceHeight**: `number` -Defined in: [src/filters/typedefs.ts:20](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L20) +Defined in: [src/filters/typedefs.ts:20](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L20) *** @@ -111,7 +111,7 @@ Defined in: [src/filters/typedefs.ts:20](https://github.com/fabricjs/fabric.js/b > **sourceTexture**: `WebGLTexture` \| `null` -Defined in: [src/filters/typedefs.ts:24](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L24) +Defined in: [src/filters/typedefs.ts:24](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L24) *** @@ -119,7 +119,7 @@ Defined in: [src/filters/typedefs.ts:24](https://github.com/fabricjs/fabric.js/b > **sourceWidth**: `number` -Defined in: [src/filters/typedefs.ts:19](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L19) +Defined in: [src/filters/typedefs.ts:19](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L19) *** @@ -127,7 +127,7 @@ Defined in: [src/filters/typedefs.ts:19](https://github.com/fabricjs/fabric.js/b > **targetCanvas**: `HTMLCanvasElement` -Defined in: [src/filters/typedefs.ts:32](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L32) +Defined in: [src/filters/typedefs.ts:32](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L32) *** @@ -135,7 +135,7 @@ Defined in: [src/filters/typedefs.ts:32](https://github.com/fabricjs/fabric.js/b > **targetTexture**: `WebGLTexture` \| `null` -Defined in: [src/filters/typedefs.ts:25](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L25) +Defined in: [src/filters/typedefs.ts:25](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L25) *** @@ -143,4 +143,4 @@ Defined in: [src/filters/typedefs.ts:25](https://github.com/fabricjs/fabric.js/b > **webgl**: `boolean` -Defined in: [src/filters/typedefs.ts:28](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L28) +Defined in: [src/filters/typedefs.ts:28](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L28) diff --git a/src/content/docs/api/type-aliases/TWebGLProgramCacheItem.md b/src/content/docs/api/type-aliases/TWebGLProgramCacheItem.md index 7d7c2ddb..89fce73e 100644 --- a/src/content/docs/api/type-aliases/TWebGLProgramCacheItem.md +++ b/src/content/docs/api/type-aliases/TWebGLProgramCacheItem.md @@ -7,7 +7,7 @@ title: "TWebGLProgramCacheItem" > **TWebGLProgramCacheItem** = `object` -Defined in: [src/filters/typedefs.ts:54](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L54) +Defined in: [src/filters/typedefs.ts:54](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L54) ## Properties @@ -15,7 +15,7 @@ Defined in: [src/filters/typedefs.ts:54](https://github.com/fabricjs/fabric.js/b > **attributeLocations**: [`TWebGLAttributeLocationMap`](/api/type-aliases/twebglattributelocationmap/) -Defined in: [src/filters/typedefs.ts:56](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L56) +Defined in: [src/filters/typedefs.ts:56](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L56) *** @@ -23,7 +23,7 @@ Defined in: [src/filters/typedefs.ts:56](https://github.com/fabricjs/fabric.js/b > **program**: `WebGLProgram` -Defined in: [src/filters/typedefs.ts:55](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L55) +Defined in: [src/filters/typedefs.ts:55](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L55) *** @@ -31,4 +31,4 @@ Defined in: [src/filters/typedefs.ts:55](https://github.com/fabricjs/fabric.js/b > **uniformLocations**: [`TWebGLUniformLocationMap`](/api/type-aliases/twebgluniformlocationmap/) -Defined in: [src/filters/typedefs.ts:57](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L57) +Defined in: [src/filters/typedefs.ts:57](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L57) diff --git a/src/content/docs/api/type-aliases/TWebGLUniformLocationMap.md b/src/content/docs/api/type-aliases/TWebGLUniformLocationMap.md index 74b56e57..4173b6d4 100644 --- a/src/content/docs/api/type-aliases/TWebGLUniformLocationMap.md +++ b/src/content/docs/api/type-aliases/TWebGLUniformLocationMap.md @@ -7,4 +7,4 @@ title: "TWebGLUniformLocationMap" > **TWebGLUniformLocationMap** = `Record`\<`string`, `WebGLUniformLocation` \| `null`\> -Defined in: [src/filters/typedefs.ts:47](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/filters/typedefs.ts#L47) +Defined in: [src/filters/typedefs.ts:47](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/filters/typedefs.ts#L47) diff --git a/src/content/docs/api/type-aliases/TextStyle.md b/src/content/docs/api/type-aliases/TextStyle.md index 5c7eec31..79a8f3cd 100644 --- a/src/content/docs/api/type-aliases/TextStyle.md +++ b/src/content/docs/api/type-aliases/TextStyle.md @@ -7,7 +7,7 @@ title: "TextStyle" > **TextStyle** = `object` -Defined in: [src/shapes/Text/StyledText.ts:18](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L18) +Defined in: [src/shapes/Text/StyledText.ts:18](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L18) ## Index Signature diff --git a/src/content/docs/api/type-aliases/TextStyleDeclaration.md b/src/content/docs/api/type-aliases/TextStyleDeclaration.md index 81c4b119..c441baf8 100644 --- a/src/content/docs/api/type-aliases/TextStyleDeclaration.md +++ b/src/content/docs/api/type-aliases/TextStyleDeclaration.md @@ -7,4 +7,4 @@ title: "TextStyleDeclaration" > **TextStyleDeclaration** = `Partial`\<[`CompleteTextStyleDeclaration`](/api/type-aliases/completetextstyledeclaration/)\> -Defined in: [src/shapes/Text/StyledText.ts:16](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/shapes/Text/StyledText.ts#L16) +Defined in: [src/shapes/Text/StyledText.ts:16](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/shapes/Text/StyledText.ts#L16) diff --git a/src/content/docs/api/type-aliases/Transform.md b/src/content/docs/api/type-aliases/Transform.md index e80d7ecd..aa1058e8 100644 --- a/src/content/docs/api/type-aliases/Transform.md +++ b/src/content/docs/api/type-aliases/Transform.md @@ -7,7 +7,7 @@ title: "Transform" > **Transform** = `object` -Defined in: [src/EventTypeDefs.ts:72](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L72) +Defined in: [src/EventTypeDefs.ts:72](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L72) relative to target's containing coordinate plane both agree on every point @@ -18,7 +18,7 @@ both agree on every point > `optional` **action**: `string` -Defined in: [src/EventTypeDefs.ts:74](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L74) +Defined in: [src/EventTypeDefs.ts:74](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L74) *** @@ -26,7 +26,7 @@ Defined in: [src/EventTypeDefs.ts:74](https://github.com/fabricjs/fabric.js/blob > `optional` **actionHandler**: [`TransformActionHandler`](/api/type-aliases/transformactionhandler/) -Defined in: [src/EventTypeDefs.ts:75](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L75) +Defined in: [src/EventTypeDefs.ts:75](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L75) *** @@ -34,7 +34,7 @@ Defined in: [src/EventTypeDefs.ts:75](https://github.com/fabricjs/fabric.js/blob > **actionPerformed**: `boolean` -Defined in: [src/EventTypeDefs.ts:100](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L100) +Defined in: [src/EventTypeDefs.ts:100](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L100) *** @@ -42,7 +42,7 @@ Defined in: [src/EventTypeDefs.ts:100](https://github.com/fabricjs/fabric.js/blo > **altKey**: `boolean` -Defined in: [src/EventTypeDefs.ts:93](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L93) +Defined in: [src/EventTypeDefs.ts:93](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L93) *** @@ -50,7 +50,7 @@ Defined in: [src/EventTypeDefs.ts:93](https://github.com/fabricjs/fabric.js/blob > **corner**: `string` -Defined in: [src/EventTypeDefs.ts:76](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L76) +Defined in: [src/EventTypeDefs.ts:76](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L76) *** @@ -58,7 +58,7 @@ Defined in: [src/EventTypeDefs.ts:76](https://github.com/fabricjs/fabric.js/blob > **ex**: `number` -Defined in: [src/EventTypeDefs.ts:85](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L85) +Defined in: [src/EventTypeDefs.ts:85](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L85) *** @@ -66,7 +66,7 @@ Defined in: [src/EventTypeDefs.ts:85](https://github.com/fabricjs/fabric.js/blob > **ey**: `number` -Defined in: [src/EventTypeDefs.ts:86](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L86) +Defined in: [src/EventTypeDefs.ts:86](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L86) *** @@ -74,7 +74,7 @@ Defined in: [src/EventTypeDefs.ts:86](https://github.com/fabricjs/fabric.js/blob > **height**: `number` -Defined in: [src/EventTypeDefs.ts:91](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L91) +Defined in: [src/EventTypeDefs.ts:91](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L91) *** @@ -82,7 +82,7 @@ Defined in: [src/EventTypeDefs.ts:91](https://github.com/fabricjs/fabric.js/blob > **lastX**: `number` -Defined in: [src/EventTypeDefs.ts:87](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L87) +Defined in: [src/EventTypeDefs.ts:87](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L87) *** @@ -90,7 +90,7 @@ Defined in: [src/EventTypeDefs.ts:87](https://github.com/fabricjs/fabric.js/blob > **lastY**: `number` -Defined in: [src/EventTypeDefs.ts:88](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L88) +Defined in: [src/EventTypeDefs.ts:88](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L88) *** @@ -98,7 +98,7 @@ Defined in: [src/EventTypeDefs.ts:88](https://github.com/fabricjs/fabric.js/blob > **offsetX**: `number` -Defined in: [src/EventTypeDefs.ts:81](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L81) +Defined in: [src/EventTypeDefs.ts:81](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L81) *** @@ -106,7 +106,7 @@ Defined in: [src/EventTypeDefs.ts:81](https://github.com/fabricjs/fabric.js/blob > **offsetY**: `number` -Defined in: [src/EventTypeDefs.ts:82](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L82) +Defined in: [src/EventTypeDefs.ts:82](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L82) *** @@ -114,7 +114,7 @@ Defined in: [src/EventTypeDefs.ts:82](https://github.com/fabricjs/fabric.js/blob > **original**: `ReturnType`\<*typeof* [`saveObjectTransform`](/api/fabric/namespaces/util/functions/saveobjecttransform/)\> & `object` -Defined in: [src/EventTypeDefs.ts:94](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L94) +Defined in: [src/EventTypeDefs.ts:94](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L94) #### Type Declaration @@ -140,7 +140,7 @@ Defined in: [src/EventTypeDefs.ts:94](https://github.com/fabricjs/fabric.js/blob > **originX**: [`TOriginX`](/api/type-aliases/toriginx/) -Defined in: [src/EventTypeDefs.ts:83](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L83) +Defined in: [src/EventTypeDefs.ts:83](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L83) *** @@ -148,7 +148,7 @@ Defined in: [src/EventTypeDefs.ts:83](https://github.com/fabricjs/fabric.js/blob > **originY**: [`TOriginY`](/api/type-aliases/toriginy/) -Defined in: [src/EventTypeDefs.ts:84](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L84) +Defined in: [src/EventTypeDefs.ts:84](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L84) *** @@ -156,7 +156,7 @@ Defined in: [src/EventTypeDefs.ts:84](https://github.com/fabricjs/fabric.js/blob > **scaleX**: `number` -Defined in: [src/EventTypeDefs.ts:77](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L77) +Defined in: [src/EventTypeDefs.ts:77](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L77) *** @@ -164,7 +164,7 @@ Defined in: [src/EventTypeDefs.ts:77](https://github.com/fabricjs/fabric.js/blob > **scaleY**: `number` -Defined in: [src/EventTypeDefs.ts:78](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L78) +Defined in: [src/EventTypeDefs.ts:78](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L78) *** @@ -172,7 +172,7 @@ Defined in: [src/EventTypeDefs.ts:78](https://github.com/fabricjs/fabric.js/blob > **shiftKey**: `boolean` -Defined in: [src/EventTypeDefs.ts:92](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L92) +Defined in: [src/EventTypeDefs.ts:92](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L92) *** @@ -180,7 +180,7 @@ Defined in: [src/EventTypeDefs.ts:92](https://github.com/fabricjs/fabric.js/blob > **skewX**: `number` -Defined in: [src/EventTypeDefs.ts:79](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L79) +Defined in: [src/EventTypeDefs.ts:79](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L79) *** @@ -188,7 +188,7 @@ Defined in: [src/EventTypeDefs.ts:79](https://github.com/fabricjs/fabric.js/blob > **skewY**: `number` -Defined in: [src/EventTypeDefs.ts:80](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L80) +Defined in: [src/EventTypeDefs.ts:80](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L80) *** @@ -196,7 +196,7 @@ Defined in: [src/EventTypeDefs.ts:80](https://github.com/fabricjs/fabric.js/blob > **target**: [`FabricObject`](/api/classes/fabricobject/) -Defined in: [src/EventTypeDefs.ts:73](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L73) +Defined in: [src/EventTypeDefs.ts:73](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L73) *** @@ -204,7 +204,7 @@ Defined in: [src/EventTypeDefs.ts:73](https://github.com/fabricjs/fabric.js/blob > **theta**: [`TRadian`](/api/type-aliases/tradian/) -Defined in: [src/EventTypeDefs.ts:89](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L89) +Defined in: [src/EventTypeDefs.ts:89](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L89) *** @@ -212,4 +212,4 @@ Defined in: [src/EventTypeDefs.ts:89](https://github.com/fabricjs/fabric.js/blob > **width**: `number` -Defined in: [src/EventTypeDefs.ts:90](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L90) +Defined in: [src/EventTypeDefs.ts:90](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L90) diff --git a/src/content/docs/api/type-aliases/TransformAction.md b/src/content/docs/api/type-aliases/TransformAction.md index e90ef173..8f34fe86 100644 --- a/src/content/docs/api/type-aliases/TransformAction.md +++ b/src/content/docs/api/type-aliases/TransformAction.md @@ -7,7 +7,7 @@ title: "TransformAction" > **TransformAction**\<`T`, `R`\> = (`eventData`, `transform`, `x`, `y`) => `R` -Defined in: [src/EventTypeDefs.ts:35](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L35) +Defined in: [src/EventTypeDefs.ts:35](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L35) ## Type Parameters diff --git a/src/content/docs/api/type-aliases/TransformActionHandler.md b/src/content/docs/api/type-aliases/TransformActionHandler.md index 028b2f85..64204577 100644 --- a/src/content/docs/api/type-aliases/TransformActionHandler.md +++ b/src/content/docs/api/type-aliases/TransformActionHandler.md @@ -7,7 +7,7 @@ title: "TransformActionHandler" > **TransformActionHandler**\<`T`\> = [`TransformAction`](/api/type-aliases/transformaction/)\<`T`, `boolean`\> -Defined in: [src/EventTypeDefs.ts:46](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/EventTypeDefs.ts#L46) +Defined in: [src/EventTypeDefs.ts:46](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/EventTypeDefs.ts#L46) Control handlers that define a transformation Those handlers run when the user starts a transform and during a transform diff --git a/src/content/docs/api/variables/cache.md b/src/content/docs/api/variables/cache.md index 1e991829..3d963e8d 100644 --- a/src/content/docs/api/variables/cache.md +++ b/src/content/docs/api/variables/cache.md @@ -7,4 +7,4 @@ title: "cache" > `const` **cache**: `Cache` -Defined in: [src/cache.ts:92](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/cache.ts#L92) +Defined in: [src/cache.ts:92](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/cache.ts#L92) diff --git a/src/content/docs/api/variables/classRegistry.md b/src/content/docs/api/variables/classRegistry.md index acd7b95e..4d5220e9 100644 --- a/src/content/docs/api/variables/classRegistry.md +++ b/src/content/docs/api/variables/classRegistry.md @@ -7,4 +7,4 @@ title: "classRegistry" > `const` **classRegistry**: `ClassRegistry` -Defined in: [src/ClassRegistry.ts:62](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/ClassRegistry.ts#L62) +Defined in: [src/ClassRegistry.ts:62](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/ClassRegistry.ts#L62) diff --git a/src/content/docs/api/variables/config.md b/src/content/docs/api/variables/config.md index de93b9b8..5a81bd70 100644 --- a/src/content/docs/api/variables/config.md +++ b/src/content/docs/api/variables/config.md @@ -7,4 +7,4 @@ title: "config" > `const` **config**: `Configuration` -Defined in: [src/config.ts:158](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/config.ts#L158) +Defined in: [src/config.ts:158](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/config.ts#L158) diff --git a/src/content/docs/api/variables/iMatrix.md b/src/content/docs/api/variables/iMatrix.md index f9056006..8310c4ea 100644 --- a/src/content/docs/api/variables/iMatrix.md +++ b/src/content/docs/api/variables/iMatrix.md @@ -7,4 +7,4 @@ title: "iMatrix" > `const` **iMatrix**: [`TMat2D`](/api/type-aliases/tmat2d/) -Defined in: [src/constants.ts:14](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/constants.ts#L14) +Defined in: [src/constants.ts:14](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/constants.ts#L14) diff --git a/src/content/docs/api/variables/runningAnimations.md b/src/content/docs/api/variables/runningAnimations.md index 8bf0d299..62f4f81d 100644 --- a/src/content/docs/api/variables/runningAnimations.md +++ b/src/content/docs/api/variables/runningAnimations.md @@ -7,4 +7,4 @@ title: "runningAnimations" > `const` **runningAnimations**: `AnimationRegistry` -Defined in: [src/util/animation/AnimationRegistry.ts:59](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/util/animation/AnimationRegistry.ts#L59) +Defined in: [src/util/animation/AnimationRegistry.ts:59](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/util/animation/AnimationRegistry.ts#L59) diff --git a/src/content/docs/api/variables/version.md b/src/content/docs/api/variables/version.md index 293243e3..52d67ad1 100644 --- a/src/content/docs/api/variables/version.md +++ b/src/content/docs/api/variables/version.md @@ -7,4 +7,4 @@ title: "version" > `const` **version**: `string` -Defined in: [src/constants.ts:5](https://github.com/fabricjs/fabric.js/blob/22fda4575b9a171e8efe201e21ee2bd9d77651b8/src/constants.ts#L5) +Defined in: [src/constants.ts:5](https://github.com/fabricjs/fabric.js/blob/ce64f450bad811750cb5a75aa749fc1502c644be/src/constants.ts#L5) From 4fc3ecd4deccc896cf34445b8ba5011eb5b4fcc6 Mon Sep 17 00:00:00 2001 From: Andrea Bogazzi Date: Thu, 30 Jul 2026 01:03:22 +0200 Subject: [PATCH 7/7] feat(gradients): add gradient controls demo and using gradients guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Demo covers one thing: that a gradient's geometry can be manipulated by hand. A rect with a four-stop linear gradient gets the handles from `createLinearGradientControls()` merged into its own controls, so the two axis endpoints and the four colour stops are all draggable. New guide sits below cropping images. It introduces the Gradient object first — that it is a paint handed to fill/stroke, what coords mean for linear (two points) versus radial (two circles with radii), and the pixels/percentage units — with a mini canvas for each type. Then it covers the extension: how to merge the controls in, what each handle writes to (lgp_1/lgp_2 to coords, lgo_N to a stop offset, projected onto the axis and clamped), the Control options argument, and the current limits, namely linear only and no gradientTransform support. Replace both demo thumbnails with rendered illustrations of what each demo does, instead of a copy of the source photo. The cropping one shows the ghost with its dashed real bounds behind the crop window and its handles; the gradient one shows the axis line with endpoint and colour stop handles. The cropping thumbnail also drops from 410kB to 13kB in the built output. Co-Authored-By: Claude Opus 4.8 --- .../cropping-controls/cropping-controls.jpg | Bin 70050 -> 0 bytes .../cropping-controls/cropping-controls.png | Bin 0 -> 136053 bytes src/content/demo/cropping-controls/index.mdx | 2 +- .../demo/linear-gradient-controls/code.js | 45 +++++++ .../demo/linear-gradient-controls/index.mdx | 33 +++++ .../linear-gradient-controls.png | Bin 0 -> 22526 bytes src/content/docs/docs/using-gradients.mdx | 119 ++++++++++++++++++ .../docs/docs/using-gradients/linear.js | 19 +++ .../docs/docs/using-gradients/radial.js | 19 +++ 9 files changed, 236 insertions(+), 1 deletion(-) delete mode 100644 src/content/demo/cropping-controls/cropping-controls.jpg create mode 100644 src/content/demo/cropping-controls/cropping-controls.png create mode 100644 src/content/demo/linear-gradient-controls/code.js create mode 100644 src/content/demo/linear-gradient-controls/index.mdx create mode 100644 src/content/demo/linear-gradient-controls/linear-gradient-controls.png create mode 100644 src/content/docs/docs/using-gradients.mdx create mode 100644 src/content/docs/docs/using-gradients/linear.js create mode 100644 src/content/docs/docs/using-gradients/radial.js diff --git a/src/content/demo/cropping-controls/cropping-controls.jpg b/src/content/demo/cropping-controls/cropping-controls.jpg deleted file mode 100644 index 5c024efad3fd31a00df669edb59e8c25f0880500..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 70050 zcmbTdWmp_d*flt~27(2bAR)osC6M3&g1fsr3~m8J@WFyZa1ZV-gF6iFFi4QWWq{>* zclZ1L?2p|&-CbQ*S9Nut>bvWzI(65};>#xBt-Q3HGynks0FZs%054mBZ&E-TO8`Jo z5x@ih0MG#l5jFti*Vt)HnMf|^05#n=^{&)Ppj4#~)JamM3 zgm@$bS^y#*0umm=OFw}6^-dIo|G|Hm{sRIc5;6)Z8af6h)@z1_w*W*0BqT&+Boq|n z*GD7xzor9_@lf#Jb4s8RsF&C*+~iN!IibsZO8MbDO$`U|_x@CLtwb_`vw_ z6B7?FAHRU0(3h`L(lWAg@@ncDnp)aAx@P7UmR8m_wr=hoo?bw2pU@v+;SoP0e}NK{ zl2cNDr=|bNFDNW3E-5Xmt*dWnY-(<4?d|Iy7z7UukIc-@%`ZR}mzKA-cXs#op$CUY zu#3y9>zmuV`-lH{z1GVAN$WNIf8>St$_o)083`HfKVArkUjGrtLq>VeiHa|wf@b1E zK+6@3PAHj>SJQ(*$E|u!Wa>JN`Hr4vivji@wf|xE|BhJ5|1W0$i`f6>wF3A8K>Qyd zAtEB7AR!^4prX726&>|Ipkt!{4>12PVE+$r{sZp+!pmzR2(M)zBO{}|?r*U$u-^WE z#>?8Pagn|(1F(@0UX2L}4cN%{MpOPC69e3vai1btvxE{2^58>oaR<<%v*?)p_Zav6Gtx|nEwLLmi}FP@UT9|G zxQCEk5jcyyZjqP$-RhBRgckM3!zq|1&zj-GQi?adh&$j0emqdwAfragnn|$MRBs;Ic>z@GL&E%Q zQ$WU9B}#nRZiZo~9l5q{Z7J$WA#0z}5L+x1%ge2u$eQYo3^LRj;-Bv^EJ#QX<6tFh z`%`0BES#kocb&;OZyV-*L}7&k{5tNh9w2m-S@71-FSw&~6tSGgI)mv~Olko|DfyIz z2XUj{*KYn&P}^>wxtqs~?Gct!Va4_}pBR|8daUAJS|o@^iI3D?XDrTeHiU9T8~b=x zr8}-rTo_D}!ibVuT`OwF7_ePO#3K&uvTCv~t{tsnxu$eVKwEbRZ$qOKXNB#i&equS z#cY|GKSG_pto%n%&xUw;`&dXUHj0)bT+pvqm3P_e9kLbF$PYGPU|WTEDa1hnoX;w# z7h%@zP&6Cx^jdI){88LD{;4&>1i+fq0K{cnl`o{OljLZmK-F}r_P(8Wv6z26jCZSd zKb+J(r?U%jRdU{l$iRO>MXvaRz1R5bb$``znm^M$i9n10XSNWOUf5^C-@ zYi>`g0UEnvs56~C)*x=#9J^7u=-?0pB=Ia;+jRJhj3;aR@O!t%VN{MP^(|t7O@v9R zc`%CSzL}xOJfYT?iQ;Brwf2~-O1h6??GBV32#1>PH56{03rxkkli%>gALe5S4~e2e zZ)cHxpo`yAQPI;PM@2?Fv%6h^d6F>En2y;itxe1PY9lz8g}+4Sq!Z;3a7dqvlP%ZS z9hRq6a{p$@(9*Yma=E6o4k z=FNRl=9_#kWVeYoJ|Z_YJyh9Ec=!AY-fq?xG8ZSyL^TkSkr#mOR-eR&NoJ1Z3=ytV z-!=sYd8=l<6M3w|rf+g%op#w2*+wFpJ9N1_g7>N5TNm5q$!x%55pBn3V~L*0V%}?L zq{E6r#~l7)f4+*>viajU+n&c0X-(|)#S0+r>ewBI{0s0EBrzd4WR!8QnV4$U#*}^& zQ*U)g-k*}9l>)MTH_`LQEG*GvReFl#GB~>#N}c5&b8fVQlj5iMF4enG$}Ygfy(ybN zTb-*cmAW-y=?h*wh1*JpA8Id&2eUTCzstN;p&c5RoKom=2V<|#uNB~qOq-k}0*}R_ z@sHhvo}obj+S*K>)hkW`VAHtSjWon4$^eF~`^`uAO`csV zghO!kwPG}r(jB453|QJ%)bHRLF!sJTXo_?7$C0`Nek-5$8OLP{nGDx0rAJ!d`WRE- z-~g+fdN;`7a*vXSw>dZ>5)8@VE&0k0B{u2fwLcXb^Kj2ttBBc0njV@E0xT@`-3;8; zmyUHS&-$_~N0xV_eoggjhs-G8x0W%3B*wnR%7}7E`3XLPBp7S4Ra zFA4iWww}S#$LY=b_VY9m_C!US4C$)x_TOTox~u2T9ie(*R$TNbm1b|#S{PC5x(=8> z)dd^$YR*zyjz%`409=x*YNhkDX!iOw>7CwI%N!?iYKDH#X+jyDpot5)$Cg34L2;&t z{%5S(8oP`&O*J#8K&CZ{7JMFOc40iN!-TfkLv?rbQ;%c8cDce(qRh4nohGG&77Z3> zz7sHJyYXfEx(D6p_!P8QNgrPBmI})W@d(5{>OU$)PHC#RSQ$kZVOIsk2B+3p?NeP# zV(F;|)o}oPZf++#eAk|?(q$qlSkLmvf*FF?Q|aQ=hHq}F)1BN`j_t}T#XLF331>bU zrs>0@IpGYl1O7M~zdX!_`K#S_FIPKMQbjbQA-^6@1wE?(@E3rH))zb967I6Gu2#dH zrX53ItxYFU*jdBlo^tAYonDYz5Qf?7*U}C?vV%HB=F~3~i>6Kcy|<+SsqH@HhQ7B! z=&Qin(v|+^+K;@8mtcrS081f2e98vpSUlu-Y@LOX7I`xWu*rMfjjFC;az$bVfVK>6DlT(b<#n zqmsAUB_vB5&iMlPk*fY0B!V4S$Cg&jQdBSG$K$RG;Q330#y(c*x4vF_vhNla#FBl#27&yM~;y4VFBSFg*1m{+5XhPTEhFT9VXZ2Jwud5~ z8%&S69Agp_5@Ie2Jkk8ndNFIxytn({{sJJIc#1AFEmLra9_Bf40H-kmT;+~LF9LgC z`z&t>8-F6j7MQ1}YozZwn1TG`sNh!*^S>)Mo1zmhyZqeY4+|sgr6LQfJqkLG5oxY+ zlLC}-rI^FyL@|7Es@yY;RIU-DG**vMnZ^(4CQV+{;zJk*Xw@zIrAv-BCk`#K?^Rc- zNII3PT%MR_c}!g1vd7s!CpV{mwdJ4C&`=66dwA41t6TnzD@eLSp{XRz)t~<|6=68z zuwxOsgv`-jP9{at`=@%OtV{?634jyQ?3=+I&I}1nzh09ja8{ad8=55QGs^q%*W?;* zchjF-FP@^l=UW$H3fmQ!cvTb3yuA=H=F39XM8dS`}eP> zfV;2S4QXNcQ=7YpX zi3#OG7YPVj$%o%HoG1_hwdg0CMZW~m45hn7ui~6FrcR~Lx7X#aezL6~Wg-5hedo`| zhGYh?Nyp!3N(z54kS|1S^}o;I7Hr-{Ky6+C#zU7F6aI=OhDRx>;%yTY(Rgz;)x?eM z_B)vmzfS#lVYH(?siPU%r`H%J%{h}ETp0o;(#s>c{9_j`AOV%^2wozqVe&tJ??@MN zm_*5Ddt2KM-Huz^2^MV@M#w)Q$?*gs26|>qQebvd(cF2tn4m`H%DEt}Pt2@F?#dQ- z@3x%@3J!W!+heO6VmuZ5Y58;Cd5)YZcFg_SpC3--_G4ms}qY{V3(TwsW| z%5&8T?!_QaOLVtXdMk!tks7BWGztBan;`c#*}b_BzlamOz^I!S4#SV#&doiWnU7j( z#dc&kHC}G4h5ul-F7?sxJn_1xjkgj5O^S?P6Xe=(*J8B#wT0m$0 zIZQH=wvR5clj(6d)51UnZ7&z7Qny&PX?iEbyx!4c1N~Y1yV$rHiHR>E7~J5Tx}3z< z$ZQQtdscftX$bu8KdF0N={uOpsoR)kgHqN#;~+~LssHE3V3$gnv|I3ibD@=$dn@b( z&@W7G5cqv2wa;@3P>cEve;5vQToiE>p|~zo`r}gn%|zUC_2}Ou;`vR4mlsKU2S^yW zOT(VN*qhCTup7LA*gNWT%xz4Ojv$ZN4~ zXp2(Y?H$6-`6No(OxYqp$${ek9xeKrboAy8`@e)$U3!MKLe(~%PE|s)y<@PrZaOF- zeW2}K&rhtd@HU5M? zI589=7Ro!gc0fgVZdoc~NSb0(;lUirr>i(tafDd3>5Z02wf1E9r*r1ak*8dyIc?!! zo$mfeI34C^K@nrj{fy(q)?~thv$+f9XtMsqRU3tZ)L(ME=)Hasz>7a`K^%#Mup^bzu06qS1C(Wz-~1^e0#C%@k)kdNYzuJg{y4 zRt(OPh=Y&gy6g*}&Owz{WyAzF%veehz?;nQX;iI6KqV~IY3zQdzfskOiZNB%rQ;vr z*9rkflA%c_SoyLm7$?8LmLTU7UADMLHA;~Eg^XL=NXGVJz+^f7F&(!YO?(~x*w-}1 z#Kazw!fbr^d&z9&Gqicsot2q}l#*-0j>Vj!#s?n!yFa4?WExkItc5Wd!}i+0hvX8h z7)eLAjYk55PAPGiM^DdAJ*bI*ql%51KsKuFi#cJ+Uj~tQClg3$l3%bruB&#o{y}Ph z#eHOLLx$@PG<{x9P4o-{{Y(|gMF*Yz=^Zg~>-xx?Yl`@Zpp9q& z`IXLFAhqO4Tw*W6ghNK{FQv;z(;>*)-^BeB`xDue1@~F}-Hh;8)@-TX+-2EqtFUnP z;N;VPN->48XAfj0OVCB^R3moA&7EHRWA&5Cgg7wL8DP`>LO(yT3`m%z6%}@ihK5;T&l|RmGpYHr9 zM*ZIhhTX4zHxSLo_O#%mQQ8tw?>?M{utHniIcl_eh2sT$!vSQ(t)V>?2WbderbWO0 zlU-GvLY6qVwW^^^x1%AY(6vTETzky|gGDtoGn7E!&GS$|OLfAaDTDl<%*KwiQ`KHc z7ne}TVJ}zX>ZBdp>oL#={{07Nk3#phXDNTZlHdZ6@ zK8WgCp%14uAkOApkx1$+dqJ$Gs4G7ohi`PeSV#xCM55H3{Y1WLwK<#VFaKCBK0ZB0 z$|r9y(Mn|UpPgAZ3L^2qG$*?N8RAmb`Gw!*v`x$Gj(|ob=e&5PIEf$}|JPPC_60x! zC)nyx7E;`tYw#rp8qbMM)~aD)$8iaa=KYS1so(Sxl`?srp|0PL+{&j8g0o^5=3S6^ zQ_=_NugIQ|XV@g|Nk+rLXKu0FIpYN|!>;lbT_ZbUS6lvc$%fACi})F*W{05)9i^+N z=4X81b|%>S-m}bAaYO*RO8*LZrX*~7P&|3!vEPsm;wMqDYHimD)z0ck zt7A;2&>4DkZEIEdfUbtx{ZrlJX$$_g=bY@ zcPmP4s>2O>T49GXLrcQFjX`S)W3^}?)3q-UH;ER>ocfz1V`Tty`aV}FBT0wwt$3NU zjsXiRFFLa~5nj_6nM8Ij%3+SvWTo}jpf?pu^t(9C&qW1qW2sMf@*aFJvp=2m)>Wa- zf_7a4lD8SmiZsaY6dDtRwx;=@`5e%5N@jl<&~MLGaN^|UgO<1x5Q5vvK}67UYCF10 z*Rt}sAhP?kuBaL_ftj>oQQTsTDV^sWaO1LEN}3knyeL*&EtXU<+(&$`egW7Kk30Nc zF+H~XHEm@sUV*~bvn)nbKH8y_Mav~blddDqV7;qShh*Yg#v-iyOa&wV=l<7C*r3dT zl(pXQe%arjOjMr@m2kh^7JnGZXlx`Yt>3!`n@k1px~Ojo01#$B(54>Po!-j*erRb}cYpD0^TX)kG? z@Ob#zeYNUTCkFfrj5W8jX7=0nA!%@n3A(XwP=G1t1`)K?v(T!**12JPxFMdRw->?L zuV~A%#Rvjw0AWiv8cP{V17@P-IiKmrP4X=TTrKRuvz@8E9f9y~$HaMdI4+l3-nt z|Fo3;&Yd7NJY}xiv%1j@nL2-SB$9itebE-Q-E6Z{rtViGljmebKA|OIdb|bs0cS1v zLX;e;t+(tQNlNgywL?q%_*4lkb?QV4p^d`Dkab6qX;t=T*TK#C^EGGRzoFx6N+q|M zj^lo>*4S$7OZk#JMA`gRbM`^5JL=pC7f6G5T>qtmP3|gp0?R*yW$|!9Vn> z#f7rM^DFfyW^DN{CV6KI3Q1MWFQ&Cj0H@1>yXFfRMHLgPUQCIN&>Xl#(|O0qbz{Cs zQJ}f9Fxx@p*}GaD*7T!686Vhc zZJuB`>)!m;7ux);=BemQo8?xDGcn)0;~ zW!0vT2jceg)mxMHe`ySjt_5$U1Lt9jF5^A}Sr@kaX>uxORVxSt$!}ttCp<$$eKk%z zC%??`3`~Qhh+&_c=yS5nW9r(dBD{|EnesL0aQ07+@H2F&@z>S|O8q3-I%cdC3Yw%i zTbq}qWhow0sGnPR&lo$&x_+MKzLnysq)-CAPo*%w2h!2sh%y&X*9YPpyuL782Kgq& z0+ZfQH`f^9-u$S83mW9loHV;dOa}fbk_6Ja)H35nbg6dgZ{8tfHeofCV%N2Y)sN98zeSz+|Gxy>32oBgDCu9t-HX>&< znu&x-BwX)8ry%4MV(u$Zgsu|90!aH4%J$hoK9;phYgF|N<8OSZ^IrgH9-sa^er|6_ zIBgIWB4_3J${({Z&QevSv^Kdf`@`6sI{WOG`$q>44;WiADWiJRCB4S+e(ws2FNHbY zGtu4#dR~OwR6Qxnj+&>(&!S(_jIL;^(P$#5?_XyQoZIjyza9*EN%7v~E-|vn{NCW$ z2^|)@hO&sCdFQB&RqL(VP|3h>WoDg32TEn3ZWa=5E@f<;^NsyEpUNY5D8xJz=kV}VG2yW}LdkPd-& z45eVty_)BI`QF^jioCO5$MKUTD~5`#hv~wu%L~a32Y-9{)X$3LoNM(fwB-N}Zm2#? z7tiJ`*sC~<0kfI=LDZl4eqU%bm2JMoaTct$z61nj*~I4GT$fT=1}L+dgFcg@y`QIGb_RBz81cu3mXoU5LXP~!$Wy|!=M!5y!J}Qc zVq)5G)AN(-<8i8B7Zaah5n^PFxAgBd<#4zRVihR-cjDZ3H|m{EFskmzd(#=i{;^j5 zt7`bD3K%MOpU$O~)1&5!CNhsBHTDui8wn7CB^TwKcWv`ES)ug!Q%&Od1^p$Dr20Hf z1Dx2dA~N@UuV9RgU>LX^NNxB09&*}lVuiCf#U`5&vZBCLVOPfx3minNwukHqz#Tc+ z%lJ>FpR0%K9w0y3g+})xW3A+j(#Jg%6lXXcuN77vtM8J!9g7y^>G2JP*9`O$Gf$E> z9T;5%jFPSf6w7QO>6G)05q}Qrj${-hJIqtq#oK><)^|i>kVW<)YS{9{3dC90KWd$= z99_b%`LW1#;l@ldY#Lx{w&@G~b!&utQ2wTXp8*cG7l{pwmAOxAfl}O7$AB&07TvUp z=TVV1ud}CsLl*C5x5wD3tv2t!ZJHR3CK>w>4Wi#vJwUc`2iu~#?+AdOku26ZbMoEp zw5B#3Qofu1h?#`TGzwjne!Xb*&t^%Y^w);Oi7Y3+08%;ON{nG;YkL|GHqSDXF*{w+ zs&e7yDnlpx_~KXZW!FXTdYJEx&cjpbGMRHA`_+GlsCe-Hq6F`H3I4M)?EZ;2P2eW3 zD$Vz(X=D@ue~8<8wge^pX@b1=NXM~ua-y9}xPb38)uFa$@H?~b`~&P!HCYke+#e}i zK@ZUN&PHO+-e52?m2%+ZOx?sEcIu(~X)WYrWUFdYQQMug-i_Y4Z8xC?hRPQJ`-PZY z{ap`?hUtDC&|-0X0sf@#i>=WIn;m%Ptpi8#BIo~JBP(!yV0WlsgDtna@(zm{NkGJ7 z_qy~qH?tBf+!%*T=s6jev*5O%>+MaWr}e#KU|jk?6>h1`jFLi;)A(lUKQ8)fT_^9i zNvq9b#c|Kno@+ik-=W2mWFn$9Ep+z$(rRI}MMKN#5SMRtV3EXgvm)?8426FJbL71M z#I)A67UtYl#9SJl^4fVgpDOc@_|TB{KUTHC(ZvfL_58f<>|7=Ja&Mqjj;w3m4?%YG zY_EbI?z;FH&kza0bHQeFeKo8H8|gY~!boff|7}Pkld1FCfLxyJn(OD^$5S@nx5gHP9@!N(q|EFAzB!r9UK|@Wv0FQ2=)wWQO~~43+fQ3n?rNoCnaQhoTOh5Uo~WyNux^ifDN;+C86Jf z0iMh1Tgvoq2cK9Z*m3+0%WU574jFM+&0Y?;-uf^uon)I9pkFA7`r`N|{(9h7ou>J& z{&dde@~muoK1pTAx2(RH2gNVm57FKX&FxqoS5 z#lZ~B(9tj5wi3W(ADlZ@4)3vP+z=|WR-&%wV7&@=BaNHmms-}WdgfP>)*7=qH- zSvJB+%MJqsU<%f)(&>kVcR*bkJLJAGt}k}%8JrF)!R+J|;q*Bp^&$>VTWx|4Y(=i& zuwrS#Kt1gT8&XgDkD#4qCG$&^9cHxCBy3#y* z@KH@4!v+_tqC?MRswlR-#)N?qNhF54I8Lmq$CxIf;iXs6b2;_vhNaA7cQsaoy+A*1DTtys?^?_r99AUlRyI7t8RC1ER&Chhv zo33_~VsyG0227-EN>=mqdxXUCnW&@`nU}Ewn~>?{jwof6RWcU7gyXk=m`6F$V-DI{ zx`)Ztsc>-33}pHyLmxV>UjPwsg|cD7Ndz0K*h_b{9$|beX=0{sXp&!$x7tFoy+%s0 zCVm7}<1s{^~DvN9)(Eb)e}^GMn_k2=~V~J|C;u*SywO?T10$ zf|jFhkl=r4@(sR4cgo+wSnTT`Co*p}#8h4{)L3H<#mdzvp9jcR`~~Q_*;< zklMp#xj7!$iokl4*4QPG4VCy>1*q1G2IS2U%ekn&j26Z-IxeZ;VEk0OAo1RMF>RJo z!7(7n9cjJoT;)b?LN8m)gxz}1_(qIjhDVurp!lehv$@Xf=`Y!Z7`=F#sb7Pz`pG>Z zMPf8a^mv5Dv~va;r`a0xD&{VzFeAD|w*e4DJ9VGvVHyqpQrT^+9MHo*HZl!m%vr_y z3y9VjF+WcUX@tj7#aI}Je1sa8{oyEC3w_g}q(vzVu|Hb+M6$J;xk@I+55Z0)YoEm9 z_GP4 zL*nA%3X<5tqWU@JWg_)_u;MstW{Q{!}E zY^Ij5rl;t)D*Vj(Mxl)#LWKonGU4@6k^32ni7Fk9$?(~ZcV52)xuEn_Sf6^XtEXnS zVnpjtJa?p;tg9;VPlcT_lcV*95|N`lWmvYrlAMP|D9__QM5i^y$KQ`o-U-{0N9g;7 zlQNibSghUF`oh4xHyeE$#5PTxw6pa~)wip*UCRUmy#T4gG5XSplFvH;M-el&KpMOo|!L zXsyjqqc(`+PQ%odIx+3=mk~*m+jynEK?zDF-^~3Ex~cQ*JGmR*kls$p&dPDJv%|+B8iW>dN?AFzF9)jI>+1CR~#qp6MQyV|f?s4GnTf z2Zs5zxSU@Ob^?+c*b!`F=t)QQ1UKXI?)6~QF*b+PWZ4)ClY_11Da54I9X~0kT_Z|f z0Pc`9ma60Q(0!xGS&|l~;_KB1UFMM5pnF_KS1urQrNJG`+xjQ%H)b=C9*tGYxOZn( zwM}|Q*}4sJ&APOhsY>n6VrV#ZjGkV~TBFS9#b?p3!S>e3fu+iCWhQLb!dF0Df=}H@ zSsN!BUqnDANx|f}lZ=(FZvwrT|0T%hZX%5AY&<}u>|8;Towjf&C62(!iH>kbtj$)- z8(_iPXy$-h(p|II-;;!qE^ck4-A5RcM?R)?(KX}3X!e_%Ap$Re>xI<-eZG_6wrV;E z{I+6#0m?HUrFkhu$V6=8vg&pAFuRx${a1iw7b*^gRgjx*rR{G;kWz&fQ)sqZd;plA zh(u60-iXc1kxY=S;VE3uNaiI99uM<;9R(~OeT|DYD=C+yOZgUywxc>~zgzC{-Bnb% z2|6wum63<GTUBwgr;OvbPMU$Nt=tFEqoS_D9$XchoOFT*!0W0+<#}B=M-)Qj$t9w4 zgR`5T=-f_x(f**&g_OJQhX|KKnMN*G?==Ygs*o48ezip2=D22l*w+nrlr}yW;IG_L zb`nSh0N^oVHXq5o00`9CJEGB%uyd@bFZaD-Ox*5{m zd7MKCY?n`xI6|avY$$)4^_D=pjD;a6TZ;VKEK?1qtq{+t`hpDY0yJmAolngUq7rI% zvB`(a#bJz)E71=V-7f&kDB*^5*)z(FvG2w7cqxpG0<_I#il>vRVdw+PjPbyzP4*w~ zFL?%rcPOW(b0^cqzt(nHKn|qKWv}+0&EaN**T=dJs_~Y+@tSVr=(D3k#F73iIB0j> zIN9gZnc$qbG(egG8f&i-C7$w4zh}SseJ3S2x3cXJHc}YVZq1fU%^c2#x=V?>e%}_` z@j7DUUhg)oJXK%pQHU}*KU0Kh{iGh7%Xi@(be$2f0jPJ=Q?{VlkihNcjK&stM%nR> z(m^t;(I2cU=)S{*!cbDQhV~j^(VGvDNyLeZvmP%C0u`xs;yfMOk%hEC1mHcUe9`D`;7RVmSy&v@YG>Jy}-qxJJ8%~eVNV%52#GiD+fo@~X1zk5I_ z&`gku0?yI9!~=dJbkn#b82qtb_OH*?`$~WW3c}8Q>hOW28SyBrMHXT=zRE~}Tb*(C zh6l?muALgup}uC1eS*vDn@F+DbA_}2Od4gH)j#H2b5ZG0%Xc37L`Ct1Y2)rdsoF8m z*(1dm?h^g0#Dm={ab|9We`vz39gA}{-PvU6nz0%%+Y5lsga+`LQq*l+JwZea z`Y*NDLP1ANE9ny;n|qdy?y7>4(O~ZVd^L}^Mmk}<0&u*U4k4v5nhw*sgR^Mkjkd(2$YhmJf1B zfJsTjTB>sTsPNm)7ZO+-3t+1Tf|fRPs^x#Flic(-`d$D;$5`77=K+Q0qj*1uDMpG- zdUjDs)lSBJ!)x~RmWK>N&aSVjg^3Ld82_!b3jMwFQ7u0CQvu{Fw_{ihSNMU~T|p9U zChYU>?5a98&_*Ef`<#25_^047a=Ws`h{wL-Z*Jf%Bb~d;{*-LWn&yQnB-xs$d8#gn z;TyzGOxQw=TbZqu<~(T%Vy8EDq3oBb*Y@RAO|g+`J_1g~u`1%CEtqlXGp~vaTDx@k zIGTDR0Voh4yl>Vco%m9;C7;cY0#uz5l)kW?hSGJo$J@Z}vc1{TZ4`J$+CKo+K$110 zb&Fcwc3UKVGTYX09`kpX=wA!!>h=ZVJ_07V;W9I=X3A!|$^Ys_7Fz;}OCw@6}!4-{g*%r{RkJUd1{FI?JCOJ*71~u{*apls1%<0do(k3|T{QqZjT^ zw5-#9&A9LN9VaD~#o!uPsB;Y`(hkCM5hwg=>@3>IKjbE$j;sFD(IA^SPc4yUyR^f( z-FAuUMI#{6m#*+F)63#okaGo+w+n|`v*#{0w9#(&zVI)sE7rYyw;^_4u7Bp61Q)f? z(dPt2u7CsaaOM+XMWk;q@i6+o3pA0IwK4UNR;^!|YGoel5<@RTFZslAm>{87oLjzk zr}owMydR=`{Ih59J~lG`kTT9E*}P?>xUOQ<5Y)dpcs|16d!Ny(W}SLVhW3LF?@0II zCqu#pW&(YHUX4f);XCLCrJ_d)x6zTIIDriwRPNlNLddql6(GT&pj76PJYrTN(9=_S zHGSR8POZ}1m{4t@S|;0XLUL;IuY7*^M0*3>EU{ngJ*2D7iBAtqwIrs&>dFt&C&>1~ zcZoIwm=W!n79=Ju9U9w==>I(pFbJ4VP31Qffmw{*z>biQwK}!wD>$XKIjsO8dO*|m zSnicy_iFw8s^G1X`rYmv%}ggu0nR*}&tM7)Y%5X!N9P1eu!rn;&Ovf6Qv%?CaOUCh*KEiE2dgBjuD$!ljk??k)0j+Oo zOsD3l3JmzoyPcniXl&j)IoxL{)SODMX3pb=QgOD-R&8v(0Df-ZgvDftOZtNEZf>_b ziFpcYlGbU{Z+G$yrf&&3UI0t;&t=y|&+i_@Ca=UQ?UGF{+0+C{{skmY9tDuk@R|e9 zPG+2;4Co_?Pn;*eW@B_DyR^Wx4Ycmc@jG7jIB1oA1(rK!Qb+#CIc(rb-H6_m4mMbI zJDuMRG2R7X&C-h8g+AUqOQ!Az-J2)2p*i{a{O7H&lfoaxi9}9e_EAYjEMlQyYQ&3qke>33kFRBo zRfa(QKV6+4B$(l!)j@X?+*5834;rJsl_T$@aiDjNHxKU58e!xL1SiIl94F5{ntPQ= z--4&%eT!7p&j8hyNmZuh+Ows6>)so)oNuq1#Y|zHLNgZq#5a0)L2R)|;KNarlxtO6 z-5vo1a(+eRsHh?TJ8}<*j0di?Tv^<6Nt|JPnR~*iJzrJE;%@xBbNKXW=8()?umME# z@As&&OE%~5rhByj6`TFLVND7gB@F6`x>FG?Hv!d)cPp{Vepl7gnwSMyr-5QG0BaS6 zuRbiThFNqcJ*ueaYV|LGhjOIv)BQH|wg0r=zB8KzxGGxe*^RrHwUQ+)Q<7=pshDwfQm``O>bnPa!sM}c z-{Rm*DREDt@%A2pALYyw1w6ZvUWX;c(CEMCc* z>Q4uAf9IQX&pc!y{z!XA4^}mm;2BQB3wtS=QjjIhVASzNW;SB>Mh5Y07H)qhSuE}< z4;L!31CrB-fLPQd3DHB}dEb|i7l2aSz^ha@xND2mG8UBF3!=k=mIcpJDk<}Vf0dKi zddaXmDkNJwKWK%tBWz`1j`l96-r0=8-nWM2T7R}AfU+?59jK!Weh z#F~EzFAADcw3lZz1)}?eYTI3{PEYKi#f8A?{z=@9>Yv4PEbp^r9kKX-%f@q3vy)4| zH8w{Tu}Z&(T`R=!OWox;@PKrO%~0BOf7cSR$;Ipha=1J1QgLvDMeoYwdEa}vbzy}j zSrtXhQSr|Q+Omi4(cEcU-eu*cu&`eL?6Z{(!c7rgY{cN45ZPS~Z1>R;KaabqfiVtL zdLH)$p2vvgRNGu|t=fPPP_|JhLO_3q(Mpks){evp0vK%0SC_xIvCP=q=sJwe)Judj z+*=7^wmZvC%3p588lhhqMR`$?&3Uw?&cMG;9HQ2kYYNXT{u=QD*A#GO_g^{U5)EV8 zSXX$o>1_mZAFY}0ow=8s_{mYnlQw_@Jyuf+WXAd>b}G4d9!KhnsSb z@}B%7m!9I4Z<1vgzkZpO1a~1rkXK)#08T#w7&H{l3;VMQ%=k9VW~iqq zy>`ia($UXKD!cZ#_FG#hNsfI%6_S{g{|WP94q-cHr}&)}$Gn3FW$=tR$oQOZv!ZfD zkpP=WK(ubAEDKaOou(NTlYKk{ZJ@?o8O^_o`&|2-PA{-t5{zb?jP;N7z|18f?)xV# zwU#*%ykcb@i)xy$vOl3L#CZ?Vp(h#*zOVDYF8~|%@PP3f-_g38(hL&}vbRL>3HJ^= zyfp;}(~Dm|gg1r5E{c{}^W-^=@Em{e}ke zkyyS1bRz#D(B&AS7_~3(*q|hj?*tS1pY>JMJjM=d(stLc^&sA>@MiI^8*e;)UGL-VPEL8zwO?yqSt8&3L+gF zrwf8Dt&oDL2CObT#S#UEg57o(CGA>=AuxRqnnSw>Z`96Y)YO*}Da@6jg;|~&`p8Qz z1?ul+n_EGztwxmqZ%vuq0-iQoMzQ!}{i23C%8?3?RJ8dT&b%*91(%)W5#`(8qT?s$ zq78dnH=-;7rt!^Y&JJUxvmjTyrFObk4}8UQ@f-%2gN#O( zfcG>G5%FmOa7g1CN`JlGl>h3Kwo`tWJ~LtR=bzL?NK%C3x{gk)cH;4`MddKBH=o)a zT;>UwFAh`ysF&0-9b zO@*AF>+c+x^}`)7x&2v3I@(S^M!b>s(VxJM{%D2`S27`Rq^&bl8)g#+$CQ+KHaLiM zWj-yAA+Azko4@gVJ&pArKPQQ?{#bv^2tvJ)Vo3+#2rn6ke&OeHL8m=UVhhil4v%T?K)m> zBBKV*r7S<_iY1V9gVFWJIP=Nh)}dj#@^ja{4G1N=+z9^u0_at-Lj8ha{^@XTyNkMi zUWwO&3Vgf!cQyH9Q9R7?(9N|ID z=AhSK6zxn=Ei(L-a!D_utv0Fe`L+}>7e2FX9- z?Wk_ohY33W+_b{7rnkg+?^OQSp0VYbku4g=YUCrBc~Y+}oUyNK z3QspVtLzr%=S6WPlMSsGZ;$Qbm^er`oD7;aSpqs&j|>Z+--D+hMFHz=~o$AMOHN!+{$CwVm_{d0!XN* z)cypknwIEW#Veu8G`=xiIg0OZZZ#MI-cH*4s(qL>87xlmb_67MnmcvGx+sP(FK=Raqep~I2CP!8 z&wCya=8eR?%-@nnh#6xpVFF(zlZSayHY-=PF|3K2$IP*3-5a;0B)W2;$Bnn0F=h;NKRSu`jJCZ*0h6Vh zkkJ5sm|+7>X-SVi?J(hKNlgSU3AvZpdVk`e^czpKfkfbCUn(asP&(!2!r07iA&_l- zKJMetnB*Q%#A-v-E@`$MrBWH0Z=H_s=Ftd?#lk{|o)O!%uz7RSB}c`OiV<&;neL=E znyjywDb5g_LvH;%iT@6mVUqogliY1KH2ZZ)FSN2k@e}#d-VPF@;6HK9>p(o9-M3hb z{OMCFyMB_V?c7+!`~nLltzt@7Ur6N0ho&@p$9ec-qA$`#Z7Z||{N)~k@-^YQnJM$= z;8yr`G{L6}?d!t1gLXgsZh+N8_DBDPH5TrYvKXiNB+(-lJk3tUHXQgk4ZQlng~DYD zgt8b7K>O=64npRL+NuDNdBEnD>>&i1Aig^*4uv5$HUAES{x1+J)7r%~ve{-Iv3Kg6 zmm#o|sg(p*zjO20KJnmH#xSgk+_qyjb9PkbT;+-W<~)X`fh4R)o+{#!pzm79a7LF- zwDrkVLBWHgU6Jw@{(kl2w9ZT(ed2c~vY($Cb>9`;jTSzCuc~Y$c;z}pz zLWVkJFZDLhOMEOhw(v9Mgkpez6wK^IfQW?zOE$ zMw%dGF~;$u#XB5e^;laN^cD2yinMm{^WMqk6}Yp8=2#KjxG=LE1>c-!x$Bzo8?Ob+ zAB;Q^9o^xY$5S!eTo4Mf&1|d}1#!`2Y#t5=O2gVZa7misp&2=JKDxit<#PLrEQC7Xp5d}T9@wlu99wFdpND)Z_FLk))3p`0xReZR^CM&wecw-M$= zM^`v2gnTe6!vtfB&RMMpNk&si`I|>0#mW$kXSOGm@vTveQW1$3+g^F{e-+{r6^7(vi>J$<W{8SVMoM zY7sOu+f1S3l^d#%f5_`vW>buzW!F>8z$Y0v&t;{Av$62+jPx5{5$RJwscHA|31PZ{ zgRGIaDpl90u6oW?l{usKCgwGNnCf<)x(V&cuXC`_;?r%U@|`X1p;FAv@k)a=XI$Rh?>79$+P<6hhtVz60;+502 z9ZyEFu(N|q4Jxe7=RCqZ77WPBk%B+oBiFTa&l6>$)FX#-c5JjD(|jjq4VIp<8-Sm= zwk@z6a4~>!o`W^TTxj1EJY92bdv9(uf?s9LoZvKGQ0l?Q-V8c}^#-N*i{j~ZWF+l8VSvwC$ndv|z9Kh+8(P*ixo$7D5#}UjC`55avH5|1 zRr|z!`KKg{4(1spr-*dbxQkYbRAAQ#MX8POR3=7AZ~$YFaf}Y< z>Ro@v_V7H~W~BkL)NH~r+U0j61GvOU8-N_~oDt1<{{XwQum9|X# zjvT;BrYeRWFXED4iTID>d+Uu?#CO+{9Gi*mCS&Yh1M~*Gx4}rVc)w4BaZ=L&NaF)M ztB${Tc9G%xS&0dt=J0FEp2 zuB{(R@6B_8@mGcIHM5g;Qccj!CS`*+@QhdXijRTWl@ z6>fRJ&vJX!nBkHGBWITYs&mf%_B{aZ23n*dVP9Ub={O&n#mjEXzF`sx8X?l zf4k4|ulUvLHpRGpK4ZA#V1JT2RYq-XxrVS;N6OaVd@uNvH~gAjtT4dm2+VRb^lpBJ zzNUuiN!+}WeCM8f`eMAp;`fD@#GW6L<|QI~Ki)=r@z~ZU!ygz;;x7)Zl;{0FP74%( zgO-c#hCT8+AO5|27_Z+`Ro3f9bxA43HhSC_4|?I8jtIc$Pi`x6IFv>M{OW|V=RbR= zKjB!G_RDD|__^oj@7KRRwbj1Mh>_!6!0_In{{UPM(!7~j95|UdN1ykT`Mu87Pe5k%OQ=V8bolk&z-@nfFD z9M_&`KNH^D;qHT|EOAYA(1;mjT&C-F*uj($yK@eQu_mUE#8+C{F0p@bu}qmG%26C; zRDTkt2Lq=S`VL*3ELIYf*HoK7BF}hIu3eepC`(5fw7o9RbiUF29c|$y@OOf4q=U(P zq*9&hC;cxP`L|%=P+HQ zW0Ufadc@ScL2D+ne|H_i%Ggx>+3V!5Y;o7MbY|AqQ1Pwht;`DX*y$@a7;)x2i~&8k z#}&d~%&N25CAz^JO(shKtMZM(fEfG4=CqYtEet4Od8c_U$B*9pGt<5}c*fhq5lFDR zvc(hzGYG#8*RU7st=o>%_3>9y~XfUK6{RELydOE-mC4^>@web&)=J6J@ZMF*%WQswQ%*0_zFy|vA_UbF|PaEl$7g{vBRcu!H&oN5|=pRB_%mR3`65@`%89y8Ak zj&Y5nis5x1g1S|u{MyHXFK#XTsoi0PWMO-0w*%yza8AN@?U3#m;fUh8try}xx8aM3 zG~bNYQ)>ELQ%58kvP8>s6U4!k%Oqe2C`TehEPeXd$=1c=T}+u9}&-Yr?%#|JHFKu zst>sE$V(17g*YDd=^qZiZd)gjbl-}4TWR+yLbcVlUJiK7ia>bB{09Tq)9SyCe-7;a zD)?J5I2_#@)?!oQE67QFa(;yYjL zjb7>@_KO?04Tk6?wvYfMi$BCLSEB*c`-?uMi=vwMYR9jCBlB(~@S`7-*OcS?%sjsM z{{X-~ihqJ07Vz>FM)5cHJ@$#EwY|-?+P%Ef zOSoa>2XkddBRqkQ*e1OnUKZDyd3{bdSlz)x8x)wn?sl?}Mt_Ls0CCSsqvBrk z;wuQ=-q=I72-9xZokz-43<1al;=QU^RQ~{pthTRXb@o<(`zjWuh?kJ#aS?H@5G3I;i>DYa5s zY->_(oP5s__^Yk`r_Wd)%TmSU&l|}-&s_Ge7x0&dHE$4jpG}&|7)6z#H~ULY({8R7 zNTjkmE?5&BrYzvGI6MaD74bjqsjYpR{t>Mr&4Y!F?u!=^F*|UZjyoJ+=Ds6|>OzhU zwY-nn{1(Aa8N?K!Z6T@oui^<~p6c!3QZ$if(iLXk(R4Xj0 zo&gK>$6E8x0;oPDwhVeY^y8~yzc<1^_IjS5=6`8%T@UzH!9i`W{@Q+{EZ$|a$__9Q ze>JNX@oWg)3Bf=8YM}&fw#6H<&*V7I;akCX#y0ifXYjAgo4aPXhii;*9wOZ5IVAg5 zJ@jzgK@@W+WOa2Tu>^Gdd9BuwBE&e(;g9qA*D&gDh4rw$f)ZM7sKsgLy+YO)~qVVoNAPudg1qW4O*)z&i7 zTgirD)D5})Ij+0mE!>x03buwvG7EVf6qEctK>7;$e8x()8WrEfv}XByXG&El{f!)c zchls1G(gDA#Ej%)Kb=^fP?4>`=neq>wN})D5mq>686SYC%&R=cKkp8mffe(y(?fn; zM@4S;4reQr-I6f52vP>% zeg6Q@0;R`OlC4E2%F!02kexPo=3S!%FTQ%3`3&A4haNv&Q4p@5d`h_I7;YQ)gCs}Xa!1tHtCv+#mn629hoOb{6`AUGj{~5U z8+afUBcYAC4OU_EE$$>B{_U~1C$10WUKj9V#jnY!y=||8XK^?PBYac zOk{Ry^j&r;_BHZvguGFuj~8EQm(cvTR;DNf$O+w!sn? z?V@W%l1R*GqdsQi^MW}9aCqoz?HuKKLT^L)?yUtE8KtQg!z-^M)_cN1g2|59vyA+^ z4iC3%``3*4?%d1cZ7)~b`?xM=E&$FEpO63qvoXd6Y@ZHzm%s^sYX^vo))xrZZ6xsm zs-d?eL<8M<+&Z4s#!ac;-#w$=6*m&Obr?AT&Os#LgUI5dgruX&)~A25i=RAYqaJ&&xZ#si1EoU|@Pl}3Rz4xq?WJ8WQU+Om&Y+ks08mL7 z~C>`J*#RDi=HL$m9$pgH_}&D(4#wA_Rc-;5$MKib>(r?yhLNT?N|Im ztbK+#b2jUSRuP-a-QL)v}{&b_bBwV8(YWL0|`#?J!k z77T|y3xEy@1dwq|@W;nZdqOMWe~9{8_Fd z-1e^{z3}Fvr^yU(-nGM9Kb>uH8yM~)le43B4eNu0-!=L%@z2En00nPsZftc3=J0ol z?Y7P|y;|L-g6=jSe%9_EG8aZ1qlYR^0RudIX{zY=zu8ZHYhx2w43TjJ&2b0-XOsZ6 zL=L<5V!uAc(47hL#oovE#|q~$%rI(FO>}qf&w}ysoA6R-ZbEP6syW! z&hV0Y_I*#h{vc|eBh~e2ON8SdUAgae`&Zpai(gY489`i@8JIc5@~1b5KVYC-L2e9h(6LB4bq*X zallzQ;BmXsyeH$EKOB57)Vy(N7_ilRDRN-fY;nM72s3$GzGdARG9WyHrA~YPrIqo< z9^93cnzBEYv)>D|8fn#wyj$PbXMe!dz3|4RaU>Tvb3FF$+gOk`qjex-01ry(<+Spw z9?wY%-csNxY!md)Q(nnyp~G!zE!>H%ZWUclKJa0Xc=a69ExaqGSwEW`MbzYB&U*F5 zeNxTiB%0fy`NPU(7iP8Ua@Lv>MW$Nn7K`SiD#+-6y^Ih(ql(w?<1U+FHjpyw87~g* zzEp>D=iG7+(zdoHlNvz}HqKAW{m-Ry`i;t4W@Tc{leA}?e}!^E%C6^KM5(Kodj6{= zjBOe*3zL8kbNvN;)A0wycJV;kTe~yJyX4w=!8|Y3y*k%NPjp`&Yf{-dHsg6Ev?16tAP}15wU@^9DLaBdy4Dt^!u+heAq)XGL~q#4TF+M z_4n#NmGQZp)+$h^7M-;|%L7Vu6zWuOTdN$+{f*qyTtzZP_SxZNb;($y7{NX8PfUB) z;}7j8;wbO@buEN4GsUGt6e~hj5qOJK)#N3cQM{T`dj9Wm+CMB;#PQvCYH;Z8e^Y%HvVU!f z#N#Bs6q5Pe<|mBDV}2ZwKFWx?{! zGwF}>n)9EAaryo&)4&-Gbr(-&uZzLU{hF&kqBx>zS=JRUiJzuU0ENNp&*xjV%dm~d zjORavVMsSewDJD{*J|2<_qr~4>-tyb^3eA=k@3el70qjax!y8&wsVfS;Qs*i ztD@8vmS{60u2UnpQ(i;x z7U|~j<=vwZ`o;GU;deosex#E4|m{{zuUsd$0lj0EC}x`*BmoR7!?G7;*TTtlR+W+n^uJ)Ui17 z(6Jfaf%HG&URpPlZmy1&$^QU+He+joe;!6^d!1S}MUQUQ1Gn@QjBos)o=ywoj=c^) zrBS+UDg*Ona&!1nYV6~M3(D+sFngzE1x9xdZ)(tBk|=8d^U>;66CJpzUU@ZzieluP7AAjy{uYVF$j<`|cS8UFz5 z)lEuPf;jx6wUasZ!Rd>8o7=^xYC1DF zlqMqX5yJ3rCO}W83lspS-;~{vVOh zxR%#jv$>8vk=w1hNgAAFOysck8CA|Yf^%NgXp;D2#P*u3b8OIc5=o346uILm>$jYN z>_c&}a3d?_BCsa|SYZcJD1WPQ99W61<{>s>gRq`7aQ<6-rD?|!6uj*;VC9`Z=E zjWXVN2NBORVG4B{l~mx5OxKh6slGmWdC~8ph7}*`?4v|MkM@~af&DApHBTApT5MBW zTj}!LNecbkV|E85XO2F##>1=Y+WazH`LkIz(fgHEC^$Q_-=9)`mGU_3f_RULte2xd zK*)H;Iegc$!@^7Z%KreV@xHC6{Cd8-Ni`i#;m8DK+DAJ`>6HKxUVq{*_*(iMsY{(| z<4#g@x;D56cL%C51M#o9?=`JgNVzt#0Xan6PCy?ndX@G1*O7RW;%AEV%~B{WJTrZ* zJgCmm+D93I^T*Ef6-35;N#lWEKZ@}3Ql{K%yY#vG-c#f3VOlYs0t!8Cx$#Qsemt7w z$^QTeRpQEoA2FnD-o!IF$K_p)o$*8BhL%F<{xH?!BcGCFkq`U^RAK&l*HPjv5B7lZ zgx5FT7w`mnZJgh{#m1;^ijMe5M0n3!Wc_RAO-OuFhVkw0pwr$!cK-mby9xQLIUr-x z>tCPZ@(fi8xXPqr{eR#e(RnW(S+Yi&6P21vq*e50H) zI=9Mt9+mK2-2VU-EP#q#FHX4`>4B(=V=he_2QQSz<^$77G(PQ*4d)nqUJ_!u?MJPj)GvpxD4+WBMT zX-b>g`X~PY1p3cS@JGX+i+F37x3a&~R%nuK7yc#pjOXSNO>Hi1<|m?%@s>X>cVj;? zc>e(4zr=5ZdX}AkrrkEHplhsT({H@Dg?`ZhK4rb#y~Yd|DlzisI2lG^$l;#%#or6{ zue01;$_OEq{$=xFCmEJ3@&`MLf_x@GtFSrVTex@VCUeco)fc`Pr{7cmQJ)sG1G<*GC z#Av#u(P4>Z5;S&F+?B`7$n6Vxpf(j;dRNB!KA&X`?A{=X8+~U)npq)u?&U_AB}~F3 z*|;;Yj3M(7Hq+E#;P;*i*ECNDUESX3miC&Jw6;;(&12@slib~GWow&sF|H5#r}C5m z9Fd1YKJ9wgyfq5cJ}-FrDm5{5v5uT+{_Slm-(9x*kKE6LzBavY?T-z3`&3)4MXusq zIe=LATgIZ)?NH5)vqb9al0#(Vf(?58<gBx#u(9At1kv6}o>@E`4Qr}$FFFAe-q z@W^Y8HrzF(-Jol2L8r-)B$8FVltv}56TZ_3Pw-Vk- zu&*a40DGL*fOyZxq#3QOn|k2oi2gu-lj&TC?M36AQ{g4|g!O%C8souQ)3v?j+&h`A zWO10~8+c_H`IPgHMK7hELy8Omn>=LBb- zc(2v6%=-r@%A$9+r{b9I2h61^DaT5iKQ+<$=yUqkw?3tKG=#iJuCB>V^SDFL0Yc!g z2iFz#2g0w1U+{(5OCO3YzSDnpzq^_vxe*8h9-(pS2tDgd;itjx3+VPsa3M>p!WL&~ zl_fF<&mw`%hhHK&o=DzdYWf6)2I_N?*5ejWH%tIuf+US#l? z5!ig_^C?nS+zi*@_K9O9-N1!8FO9hL9e-N=2K~BxTXZe-F9k>Yr=5+=>ztC^0Q@WB zy#m3bjNK^1D(zpO&PU^4jd7M^&xw4yEf4fJz#NHSG6+?d#ZmKp`+f&ET{imM^>azN=W&0_AI$rOoA+ICeQTh#Va$wh6-m#q{{Zz@ zJmHPBYyI*CT}h@PD=X@l-uk0VzWT6^A#YE ze$>fh^2l;`7X3;~~C{)pN{X6ZqD0-o#ac zT9@tPV;L+qk%lAMuSKyxct_kP@--!-3Ph4OImce~jH%`MWbw&AO3F*2=SrtDWnD_% z9Y)>lr(Mf1$Kl$(Nbn0w;ZKP-dL+ZjSsqB#9tP5KzlKHyeT6%3hjR1-1M%X%Tll+W z{{RU80E@KG7Dh0yBCBJ*+#J`tlFynGqWYp$lTv*@CVf@CS)!LcLslN7`_M=RcnSy9 zbNy-7w=vymcJsvHmPIV2bRdj_Ofelods`4TnF$+#;Af1ScILS-lzFPg9%Nz~rAl=l zME?LI|Izu@(hs&l3n}H(AByz+>l;=xXxElHn|gNuz~DyE7ml(#JhHQu!o|nRGmNqP zJDUEp;Y`Lj%oHm(s?qwN<(G-vJy$8tYhatSZrb#F9`E4oF2lrHllXjmk%*WXHslGL z8%BF_Kh7)Ev|kN)gToiFZG2c(+E>Z*4TsHW$6TUFy5M)d|pG zjPu4g9cf>YTyUo;y$x^e%S^~G@8fSTk0pNaY@UQog_N z&7O~^#1l-tk*6~tVC@aOrIc_wusP2-7|nV3tV~zBw>_*LT_tHq^w)L55CpZjldNUIJ0u6?a54(ySI9pXynW!G79C4g z(Dj$_zlp6GZFLU}>M;vFM&5S7E`Sh|DRa!qS#i!sO8a)_#~upsRHwvVG}j>0t?f4r zlDc`Mw@)oUibKkPqxG-JZ`v!xns>)f9M9sdPfty=zmsJS!{%Ds#DvGWf$Q?qqdG@v=Q8Lf= zb8&Mj#IxNn`P(jY<*3OS?SgUNjDHb$m}yg8OLb)>l(RO=Nu&EzQa*Zl5@s=+jlU=? zJ+WN&v*8nJ43Kz{k{57R8@UXR!2>x`-EohZGt(s3b7kP)3+vj1cHSh^9L?mrnBkF{ zNtsmONZ({*3iQhaY$!P7Jn>Uh-?;MayNrm>Qz(?A801g52j~aM>2(RXX>OyWUhE`Z5PbOt6 zki+I-gOEWEe+u<0-wymQ@Rib=t2+qf+$0Y*-OTC$7{LDkR_86rI|1|qzHXtU==c5| zz1KVwr)heMi`Am7$fG07;E)FG$C~FN@TJB5`zGbJ zg?{thGOl*BV~HgKePPM?3ho{!3#NYPReld$`(B$&HdS9xzmlFji5} z;MPZqp_+DmFG#VL-pVlS(@htWvOFujk`>Dy00oJ|9zIkV%2?UA%JfFD;i@#+Z<=ye z>1h1f()css$AvsqZ{$O(ne{7hLs{F{O7c#TjL9@p11xN+2Rm`MrrPOkJP{s`;|mW9 zXx1}ZYC65TOKWZBBTFT-10qgChGj0fY`Vqr=K~e&9|ycYHkqPn`f9J(?llW5-5TOt z1(V9ZxVCg4_5T1@D`5I@UpQPt;y;QX8a3Y#X#3<%R`ztY@I4(n;R#_FnGaGu&eMG4YoE^5)CJejK}s?gWZy{FA=wG;#8s zlRN~611b(jQaGwNx<8D(Eod}tTSK_Ex6|fFmOK49b}Zbg?w;IC$}_kWW&ro?U#R{D z&@{h=-w(9?8%w!+>-*TDzrVU^GV@%WtT)Pj_QeXIb^wklo{K)Kb*m-)t(3Q6yyCwq zsdq834l|AWT&V<+&~wFo1s)EoQw{BETJLLlpN3;RWvztA&V@C2MYVV3`D%P2tb9@U zgKgnk{{RQ-dKR7H4-M;f@Hg3Q8cFS<5ex|;Qv2=hGJb3*9>8Xj~n-eMdt*$nm%7BtRkIcQZ`aK82zX$l6M*hdwyg6qr(YGpOx`jdW z3NpmaAj>d|Ameu|JuzNE@h|o+_&WN2r>JPg?m2C3LI4^jdy^PnmPT|Wh9f-ZZ$NR1 z;H|^;u<)Ng$#mTG7m1mEW64UjK1SZXQ+@vc;GUK6qvC&nw0%2D@RpUVw04&7BwB2@ zvZd5sMn++d?mQPo;HY&hx%sQQxqP!szIV69=jMH}riPN$0h7$&eBJ*5 z8q3r#FZAa!LIkmr2@m`uz71BhyR);hO-8|s!8go$o_caWO5y%6{6)6#XTzOm#9LHJ z9kVPzo=mPbt_QI>uh8=v-o~7&J*<8&!#Qm6*vdF+Ygsgp#~<1&#Y5r;$BkzB8_c$_ zV+361?s3QCSXy<8!(|L)bF{JT#dH1}vX@c5y3}s+*B8>6Hy-LvPwQTbCzdzHgF7&* zkM?=5=FH0z?JGCZ=lYR?!^aDTrG%V6^eCnE= z*HV_Kp#K2A`L8bct#&UwSu`V+w+f@%BXRz9?_aaUlEtR#_YA*%ppPTjNk7b2(PQ7U z%ei}>pW&OSnqn(-R$rO)tgKMLrJ z>~JxUt$Z3jh^=?kzGA>(RO1-puy4W%U5^+b0o&6x(9A@b2aL8`=qr=dCoIj^j(G1{ z9oR^=%%=yb`9|TI@DGXm?L1LosE!IWFYl1V{{S&xL!@QZQ`C&tfP7$#L#e>>e59;+ z)|6U3-g}WdqvrvX0qKG`r$)ppNP4gU4z+`(Ol~x*8IMyGXYx^+ z>ETb^tDGF4^NRCkttO4@E>u{C5xykqa!DSwt&Nio!x;Yn>(y&Wi@QtwC{!A`bCiAU z#!pJkr+cH!t2@fZowUVLM9IqI>q#mfBr2Xm4E;Uot*mU*Jd$!9asc%mb6b(bjSC&T zfrDApT}}#(Mnnh$K+1!5TN(DRBlz2*E~DX_h~r$%Y8F+;sTuy2?RIY(z&>0B$v&B` zE5)&kxUOI%A2uMo_P{*Xep^0Dv6q>hJI%G^d4IyKa!q5xw$|;P)>(|4{ww_P_*c-s z4Rn{*e0!u>6%1NHIq8HU&*-)BkHUM&to%o;XaI<^+t40>ZqH9(Ywf>-Qf~3to(AUL z*5QX=mob>~J@+uheO_0W^X9Op(X`K=)8US=C7KwE044bk z``y2#eKo5@TTWF&`|E{NkB{QVC-72F;a>xMKGuAz(H8Bw#twQB(!TrAZT5UaRI4`yBnBLsSkSLUCM^oXx)<%O6s$Or&+ zB=MYj4wdyk?1|&W*E~CO;d|K?b$t{pGRAl^q+=0GJxeFZ{^~tz^p6bl$4a!Y)0UF_ z)$RG8%%4d<3|QO^EZU53Dpykf01LLiBk65#Pti3;Snk!Lnl4d^WF!NQqpfgy_u2IC z3F^`KYH_Gvc`{235y`!r?IeW_k}JRQCZVBOJaTI{DQMg>vywV=`gP*Ga{l_l%KrdK z@ot%Lvcq>ftICHTxtS0mmBGP3yur^u%l6D>CDVeo?_>DWDZ)mi?=_;-uke1>%T(~x zT1KGBEH}3865b~dyUS6X%yKr9gZ|Jp^OwW8uQVTsad>xKk(T#Bid%W3R4Dj{5?{UL z&9m5R+7wB16w!jdd|^&vZa!pvzjvyUp4hJw1MOOrX78!>nUkXirA|AeE5es!QTV^( z866&50TM8UiNpD^gmA!|7C7(QHMt&yE+NzOyT#dOVzY~A-F7Oh-3JFJZy@uE@_&Z+ z8l}DNx8^e&#evzKvOq?IARWY#R1?9j`dx0qI}ZRS@mT9k!J zNeefX93_k#XW+-Z_=n>dQM|L^@rK>1 zD?*FU-zxaW1v^z?aC64KctzQ5cc=Ul;&W~(!Q}q{xSeRZy&8)Ctb9wRufv^o;`Ovd z*7Zqe+|O*5@Y_%2wjM-A-rJoHSs74`zbh|#-|$uUfV@{@b>UfVua-dJcHc!3JWkmkB&^sg#lPF);aR3m$$|1bUkF>Tva0!L?2Pr-M_) z47QzLXZ5FRbWYxk@%6FLVT(e$(qxY3ZN{8#e74-BZPpJpf&S|xOjP#=rG8&oU+cdL zz9P?IsKG6?`Zd$VJSCbpTru18DaiRqDo1h+eu{YO;m?cw2Xz(ih2}c$n{Lj}_I6jf zQO@@YND?;JJJhHT%Z;vEJ35|^;h)+A!8g7UwY0N?Q`N7mZZ!R3NPu!6ltUy39IS#l z0C3!{0r{1|9~C@3Ounn5h+gcvpJ$5CY34L2<{5oXZcQY-pZqgEo$xn_Y(69Cz7+8s zB+7N0Hc3Wuje8Pq^KdxdEO}x&Z&vlMq_lqxY0+6l4C3O}c)>Bq8Ji~^3X#zF0~Ptp z@HbYy@E3{vaqw#L(%{44ooUXAaVoeHJ-KIC)yU+@Y#6UUFeA1r^&i8U+TG}uTHS=k z;>PiJ$Gfh~R{( z_&a5#`1e-vPMD)k()EC{y{vyKrP2nCn{OO4;DS5n+P!)W4tpD4vRpDqp@U!&2tKvF zr@g(fk4%d3t7Q0JXsXkXytO`;F3<6lsZ^oO?#)@QmMdA=L#5kEVK_f$ zkdxftp5XrgO8oTwwft4&Po(@e(BWyvGr^mdwpy4Z&uW_{Vzzo*EMO@ z9Y0Tr=bfMKszx$T_*db7h`dv%d{XiDx8v)zY-)45T1G~Et7Q3OUVRq>>t74U*{orQ zRPXOI`Wxu&!p^Qfrao)jq_^{AIwg;jZyb>*%xm%=@vBoJi&G}=n~*^swY>$Hvxmwc z6o>;#wGjtIR~gy`k(%_aMvtaLR9n6e~oo| zq>m)69zJZ~XOFFM?2OlVZruRsfm=Bq&I&7*=7qYD(1Xrc^!BfvzB#iduWSzkW<7b& z_*c>P*jeLO`>~9l#=dX(;KE&Q&4I>KIQp{>@UL5k-|w{}7T+tkm*#p`gKrl90K-;N zj&OxD{^`K|1$sTW4G0H<2Tw}jyd9?-Uk+*U4y_jQPy2atJ-XMR#;CD!0pR}t`s>fd zTiQz9&a6bXPjc0XNNvkEL-P+)_*Lw0mN}VtQ&|wPIN!pjAbQsPB^Eu>9D~jUW_h*r zcPy{W#iAJ@c+YIrpt2+n8#gWKRyN0N0V4sOcpd$!Bu&$KlJz5ieY@1i^W5%bMw6f^ zyD5|US3Rq{I!gTX1331su`i*5Nn?I;#~z0wxvS_}P~aToe!lgkDcVV$lqC7JK0~m+ z{=@j21p9O6u|uBwvx@yb{h72>xz~I{t)HDBjvHVxz;S$zezyM2Z5EaAyy_B0%=(6+u8bogokR)9CxW|_3jnHdu+mmNUooe z_{WX8tZ@80iKgE2x8JG%)BKmyq?b(9iW9V>GM{ay{QgzeQm4hqWv3eQ=;>pgmA!*QCx?Nbl7z}7lPn_tXy>9H$2zL zVX+dWHBoMlc6bVSigUu&SB#TP_YaJJ5g%E+)3l8`SY|rVhBGEf{lVKOnd$@Q<@PnV z@atBBJM9a?caw?q<(~Xq3xY!IgvA^lX53(|rQuJ%1oS+{5|yg?G$Tv^*Oxp`$!Cyp_KK*{fdI34(|LM;vaS2u!uJE}_Z>v8D2 z=9J`SNH(l(A;{0ldFP$His(F1q-q++g%;n-Xmvd#= zht{$5Z-=^fhcscQ>Q=E&c_3jk$%os&mQ+2r6PIzz9P^GV!{S<4oKO1(8Qb}vWzipR z;r3;L%A3w{%bBNWN2`Bn{IvO>D)?XFjsF0RZ{pB&%SM1I8U}b>` z8iU9n1A^7&{v*>S&=*;n((=mU%GKH_u91wOr#n8**&B=UPeL-Mf`=b${AuxG_$R?B zrcW=It7~yQHn7AzxZ|*Z192%-IaNr@BI6lmCpoXp{ZjVkTYI|;i=@=-ttQ`V1V9Cr z>QTI|K_Q}#1duocvHQ3O^GdlbEEM@vxumy!FXVq!@J|!tv$}5;R-Yv%{n+)lR?bt# zy8Je+W2;>0ix#u1BhL-8fFjfERq+y{akQ}+$r%G_9XXcML|r#XvDWNhj@ssXPclXT zWyGr6y8PJ(pZE?doV;7x`SoVi<`-AjR}mx17l9fnB@lCj1dI;7``1ysSMg1qw}-TO zfYdG8*2Ew`Ia!M;5C%_01L||!RMfM^g0+=yE@L%*2~Q1?e#r!;lQJ>z1W|S_|wM~ zGHe|@78TlazN@#Fp1+BIQt%hTeL*3MSMZ*hewMlNh25-ksuPTmBn`>H$?8vDY1iH* zx6rNQu+Z#bwSjn4w~1p#iU)buLP1wCvZf_cPRQk>hjlF{)XMNj!%q#pgfrYDUEV};%Hgs|KY6ztk^XUBUGa1FXNJem z@t49V4W-nslIl8CBq~no2>VT-Z`X%Rd_GGki^56HZ-G^xqX}vYE8a zMrD#aFFeg3+Dobe#%Q36$q_KfR@;o=x6}Us1->ELc!x)mRF}@uv>E0W%{}x#XOi;a zGm&j>PT(bMw!xA(B;z1x{9X7eJZvV_ybG!S0Kz%1O8#uvjU=?Zd|(-3b!89fAQ|<~ zQQ&$$iSc*BP!#y<;Rv<=01jI$kgltzq<2$TBV_si0AvM@z;IZ^s>7~$ugvio7B>S? zRHnJD*R7A=W5k(GcZ77glrOv<_wN__AA9L~m5t4~y@66od5QAJLdrTEdJkX9wd0cA z2$D2qJ$_c{UoChW!hRsrv`Bnc;SE|{Vk=i7`%abGSngmSa^lif%lzr{1!7NN-K**? zD(gtpbjwX%2E-SUtccC%-Hr+5bg#V0b9ITNr6p;3AByo;41GegRHw}Z?dG4EtZ!{6 zP`4X_BOANX6lt7AKH>h*!K$-b+B|2;nL!?n{VRg;*Nk+phQ1QjJZ0iJM0Q$aMZnMc z*E}R@JF^}DuR|4DG^shuq2y%Qb$nhX7-~xLld?Wp{kT3UNol3&-vxXpzX zd5+mn%7^{q$@U)g@y~`dsH|;+pu!-+j{I?&$+grqpB;FURq^kMShlIINMtI1<%~rB z?EpOh73dHM;Eha}3Ya8%5{p2Ooz@%ZI3YOhWS1^|N~JjuNcAzca@4rQ0e3bLsr6^ta)qhuM4&rNVk73QyGY z{cH1QMuDc9B~i=Bqw_hh)eQ#NTIhDRs4=!RPCWqs0P9z$#dU4UyWH`zNH}0%yRp{R z>P(@A0MF~iSD(&>M49A|>zcm|f=Hw*(T;P)X6o{V5yp5JAd2|-=z6s7sya=az4!Zez@mox2}QRxw~Ab{$Sn(=}Jp=h0AhRxDVty1AA@ennuQdg8u$ z_{xL(R@q0)#PswT82xi!Ls`bqz?kHYex&nXJp5b_Cba-;eaQMBR%2eaN&H)mQM+r< z_iqbEKe6n$jv5H_^w=v>c|n-Orvn({t|^*TtJ~?idP#yji28rHD(YJaE}ikv0Diq| zma6xg^CDA??#PNyD}L-A02%hKipt*U!p0Dvm#!-1hM2}k!wt+x`8>dH(>7ygio5(y3iJE{jw1!{T&uUtUM1pxroP%DDN9F$00_c=f#j~ULx0SF1Hag ztV*%%lOTMU$pCd9&o%dd#C<%zf#I`e=1A?5OC~PmiSmM!b|)m3Q`f&*{eyv|OMZ5;gQPdH#YW6=KqBkf-nUU+8aJIN3x$>AU}9x}ZH z_2&nU1}pJ=mb7cpbR>VEIi?z}9}x_771qr9Z2O7*>|;Ko3VB2- zSnLGpRB&rU>*}>y*qS=W^*mR^*SepBJYlEn+E51SCT+-iOAgW<7!In#f<5c({{VyE z*;Dr9iPO)nwI)i#}(dXYfscr0{J^3esyHu_R zu*H7wEJf0i>VKc^mn7V6vB2GUPSV=b`$8y;zx;sbImf_;p2i|r@9eCZr=hK5<5dP8{(%$PA zo*s;uJT>8o6x{*LS9+ep(M0_6kf|Go_m~dcc$wB@u(TYP#Vrx`{0G9b&N1#~qsv9?=iveJtyArqAjKI&{zU4ZK&AmoP6kej=`FJH5} zn$T(5b*GyIHmpH(S)pi^oOBLL0^DRA)>gLn`pwK1)-15v*+Uq+*f#H)V$yuWspOG^ z&;?%AFNrSS#G04dAvsIdX=EhhYcW1xC)74;^GcFd=YQ9k{q2zDp3a(~70Rt|@?Ro0 zL`%Q5O)9|^+ih~^0RcEiB=9g#B=$9S9}Zb)9vmJmTeY>n)O8oPwH|J6A%+mLG`U}x z z_OG$p`FuiATWFJU!Pr301EqZKDz%fot9$o8ua!=G_O-e{O@Bk~U)fK=H~LiCdAYC= zSn4G;W|~qKYl!VhTVSX%Rxdc0EZE*az{e-_Hho&&R@yS-IN*A9;=XJ6OX1<+yIprw zztn!z7VT_fxIgO57HF}m#xih$vw%Myb6&p`?JCiv&ZMPT6#y_Un6#F_#AmQtPz~x6V3;G4*vjC(y{M8$K|-1;dmLsa!v;% zn&&0Bjy*-J1;Q(pcEDhvf|1ak2_%3Na(fErujSNrJrh!cN?2Ow%8?WX-m!ScRwzTE4A%3N6$YO{8Ods9wf5TR_;k{tpUK=e72Af&IlcLqV>iA&QEIn z8}L4`vv@yByorp8AVMD`2EfKZ^fmc0t$1Hn(Qf0s@iZ@Wcd09)!3UVa81fG1kw8^a zz<1;idivAhSB~y&bV$50cc{lamRo$pV}giOkO&|U4{Y_vy>Qfor)1IX;vG0aI6aT9 z^=}nJvucb>Api_yH)@{N$?l?7zL-Uxb_4v)dG?KMWhStYlf*B-fLZQMdG3RLLxjf);oSbu3lE&}I z@*J!%4so;$9OUC3q}Gz@b4r_{kfUSpHC}x;P)Ldr&c2zzt|+)iNV^@D%qmoHJg1;ocXm5-1d~x`IJR#wki+Df7(&b1WE#<^~G|lR{;Rj4} z-o0P;v;CqT($;^2e-5Ve^-JJl)NZ0V5X64;NJsHEA&=C0*UG*L(PGi8MXW>jfPC(H zk<=6HJ9?V@d&CYWQeRi1?z*4a-UWDO@Dx9_@v*ezy~WvUudidcw$tObh(v%f2PKbO z`+9m(Y7w(25V6W~Lma6Cw>~O=fCx`9Q}WGC&0VewFy`?0-U1=9HDr zUslzjiq1xlq-aZy`Ruu`gM448HTJtKhpt%QSJIynJW85Hw9s2Pl1W$QEB8YT<3ES; zuaQ;$*EyMvNy+@r_*dU>#t)JXt3F?j@yZnG;bFX;+28m!A2V3f<0m`kPsfle^!DC1 z7KEozqz>Jy^H1UZtKImoNmSr9+$cZqteX8bom$@3I3wrf=j-cUClu>eCv_I%hNTNx z>-reqDvv2iB#;l&{EErd&zma72?0h)HKBVp3MzC}C$Cz?xZcOEO8`H_SIwoN=;7h2 zY|CPXJ%@nVKS5dZ!5S{el$HC(p4?zomBc8R&)pd~s_zcn$TPcw$K3J<;ZE9E^r_Cp zRgfqHBOv1)IVTn1-xZKIitViweA^*G`0oDz8u}6#R!hZ?`-3Nrr>%VX;`IA>#Jf9O zl77(&pFmWuc>KkCSv-B_`y-}{PFf#GY(!;1Fe3qY^cAaNXvn5k`AfD*J%FruBWY&d z+?G5J+*a(Taz_bb6RRIn{u!@2r0(v|F1x?FosEyR2_rDuorph=zrH=|8s_>qw_71H zIXJ-Tey93WBH~MemUi2iecUL^J06Mv=kl*(@K3_{ZvOz&d`pR{2?$3F0F;cB$7^2JBXwN^x!N<*P8V| z_(D((*D`(>?_N9c14g#fekS}l)FQO=-DkYFlO+7fBF6YQ^eK^Cc)D<$p;jwczt2On z1u4hcQw!1O;}pPhL>io7dlc_Ew)vq8ISA==}=%6&&#-LlnI zR7n9PvCe*-IjYxsn7a98Y`SsNujA?~`NE$xCCvly@p^$VDEzYk9962?G`NpM0Kq`)o`Tq^GSpx~c>*8czr z_=o-y9VR>IWH$%XIQ=vDx#Fvh55f`nvsQTGUk^05 z5aee!rZWw{AMCTU_2X`FUx@bl=8>-W((Ze?eCcC`TY(|TCgXNUZoNYgJ@9>M_?Dxc zbxPVq`o9EnsQpe@m!q4vuJ>Or)S`(djcIFbWX&^OK$1KX_G0Q3T@AV{itFz0c zC~I9>=1Xa$mOm+q?u^1o-{t@dZXYfP>))FB+*IwN=zmFJ*DWV2>h$#UJ546f!&crA z)x1ZnYBus}S2l8sXa;7J&5_n61Rxmw?tG#!r?$r0^sq`RU`1@O_U3haFZ)?$0c%m zbnRc%7#Kp99u(8ENgw52X^NeEWlHi_a&7(W`MQ6Jz8ksJ=C`ubE_E$NEw3C={LBXJ zo8&4mquV(3IIXRBPfL#u-Rk}wy))iOvAxV_zN|CW5{wKJFs*2S05=EImf+ybe#Y zA5Pe5x=o}?Zl-6Mff&X@n%9c@%E`mRjLy9{1$?IQ0X|rkWHVbX?`jCA+tIoti+P8DIgq!zvHEp$9$zOabQ$Lk_pZivR(=&W9 z(2s&VGccdUn#wQ&GoP};!v;n@iR?P}^se9biv6NAUxEG+WVKbB#QKu#)9pqWg4}to zI)qcxJx?70ug6U;U1P->{r8FdS#bBdrPRJ<%#3rKl0vVdiu|XIIFb}#=+fN&u<$Fw zd1ETaGsiF8t2Cci+~|BAqcjFxYg3TiUR;)GBy;mKo}=hHSFY)>KHoGBINj>l>5rvx z`e2Gl+n`<9QP3{~t#y)J+FDy1tILIg-abn+U}N#G!0XC&XLq|lv++@~NiZSexlAM0O5`pk73Pybg^`> z^!X1095so|u^(K-zEp^Q2P|W1rgK+zrr4n4 zXv>q+rBkvtNu-k?vW&z9*~gemW7KCkubZu-68u$M<%Cj7<2;aX*!^)|NL)IsZO#g= z{{YBm74wgQ1M0p!)bHGqB3BvrBo04X^|IvEI+F4_aJ4OW-1;WQW9BL+AaYNwY^;*a zxg%dO+=UxKCzF5&i9_%9GR!w-?*CyuSU*>`5QgM1|piyGZc7?V+B^SR_kJI5ct zXMU%k<0ShEY>wXpgOX2939K|CD`0Q{L4n(kN?^T?INey`uy8B-_aew>;AlpL6=b)4 z&+_+-_{SHV<7bS;%I)mBCD|IUG6pP0?2fs`No}S*=>fqplh^$J09vD`=~q{$?KdQ> zCj~*^p4}^~xw*8{ZMMi&HjYMd&3iJPouYh z*j(HoU^*U6e8H&vbMSlJ!=l=2cEaZ7Z?ndsvRYC|+0%oNbDH9>ekOPyPrQ~bYs9ut zT*b>HPP^4}{7MNp{40_;dQV!6@4aKZSWug8Xst>&5qx*?4!vHdlAj{lwk1+Z>-PHa8!p zcGpA10rf8*BF7-4&|JM00OSn3PkK166%bo$YX!FX* zy>dOss%dj8Zu34?Cm`3o`0w_8@!yAhQ>|+rAGZ5ujdG#(AloQy*}w-GAx?A1I6W{c z#4q&A=eS7cvziHBLlEB)jI@fmE9g(q*W(!Mnxz@aHrd$!07bZ4j&K=;2v(<6d&xUr zxda-`jntpnb6kNq1wt??U;W&HyYS6t>beYfc8K#ZjySQqKXsIhVEg)e);^>Si8k84 zopC+0eBNY9zhMXOf~R_w>KG5kz01H8!>Q?3aQs<@OTPo_GMig36~v-Ou$4i?T86`k z6CCBX%DfQ7e6-<|xl{I#c5Bn~Idjf8h6cZ}uO4X2`ESg){m8x2EfwSQ4gi&RZCPVd zL+xRXpd1m94R}teq(ZWonLM)*1z#Kx4$?lq(z`I3hdg;IZhZc2kw#Pc<_cOjxApTq zUs2bjv+;hPuSantQ0fb9bXq*O&I0mRqwOG^d)ME8v**V67JZ2;Gu_;5`yIS-M+-?S z%Ih3)u?KG4y0+}ED1K51{J_4FSv)tVOy`>>mei5M0iDQm(-=7X>!Z-TX+Dc?*1`zy zqLpFXvgMK{Rb>TNAgicvm4O6jgI;v75=lBv(vIIEGX)G~IbksgH6*ltXXyU`?c?!w zA>pk9z}hsPRQifTs7}lBkQ@-IM^IM>IXoUK^6x^9WwV;N*}^%cqKLu_(x2Xro7ebfV=*QeCeyf*$KT}Ja)({ARo zdjQiJBRD9)44n4)h#vLl<6N9&t*(9T7;;XO61<(=x^2J6={#Ab!Ke7|#8Acx+v)d@ zZh)=}7>G@Pe|VA8wSBMfBg5Lf+HZ&TYn!KrXtfyQw6u&Id1W1@mCg=dl~wGyI2@Yz z7f5^EO6_m1=6UX}W@#jnRxC-8w>y?^Qb}Xqt$o|zUl(fnM~FNHd!{Nch3xffYgw+P z&dZyI8{J0LBn2CG@yh}AuPU6Jaa4J9w3Xl7aB+?rrCgS@I?6KBzK>6t`hjb&D9xqJ z(p*NsaUuhb++>=D*G$u;l1Poo#GvdULX|$8WAGJn>AW$hm6qJJMnD*{AC-aVd+#6=)INohbriU>Gg>|LeM^#tmE7yi?%~63$Ei01@6pr9guv=aFI`hU3ZlSIYh+{iVJN+f6JQ zJ;m;^D*pf#tY09<`){;k-n=|-7GSW?_w_9NwfoPs$h_( z{i4`CvtG8EbShbiB~S3~BntF0?9v#De$tw1FTdz`Ip+`6z*l&B&Mr%SS9^JSl~&Hd zPE0su`=^tS@Tla|Y^5a2ZnAgz{$W~zG>`7(MmtlsD}%fh3OOX>kEyP?)=^GUdLC6g zJDikauX810f;LdVq+pMcFf;!E)~_D;-TP8_PvC}uB1IUw*XB|!Z1^l&AAS80erCM$ z_K5wcJQwhTNt;g6B^sBACquG0&g6(5H@gh*FnAoFZngO1toY+n@gBc<;%^t+8=X$^ zT)LbQ7&e%(e=H5 z#h(#8S9{|R7hN^xt*GzayzvQA8Bqs7HuT3BuCi@gMbK6Yn~S7Gk#Q(fmdF_x9;2mv zyL;nZN=6@KZ!3VLgU&$4c=k2VJlA)vy6Q%3cFq9Jera1IooRE{m-(O8QR93z9t#hG zhc&cakD>M7jTSac@aRzQV}c8MkMrEuiEG|E@gIq1FMo3Ggz*?ZDE7dl()=%ftGHWe zi!b{l1D{qk?cN#qNe#QD#;!8JWFYDIj;Ha(Zy4b)i$!*F{ZBW{-Ret{9!H1i9u?NL z$w63~X~!plUf1FO0EG}h%OxAOs_KIp7RrRnN3Y>K&u#a=AV6(-nl4wm2%z??X!Bcukpe2ZH( z5kfPJ0)NK2ZD&#PiQUw8&lUPaTb76O^wL_hS5w#R>=Vm}_mU2n>}$&POlWq;m-`h>)Cd&*?cr)RKf&HDOTSskd7x&XihnnT_%gV>*c5eCl z0gfy4Tf$nduWkEX>bi%98rnOhlTldS^8I(!WZ4VeudA`gN?nHPx+j$)rftmwv_GN6c}ONzQtH z74m27!>m4fzY*heFbu5fS|@>kb5I6a8SK6|2g_rY4*LE%4*nrvPc*YXlS?I_Uc zx6%#-mRD>HM4rA`Wsy%9$2Fy=OqR>%YmV0O78o0MV3Uj-fA#Cr&Y|I*TT6X5^jT_p ze2SsqxDiVeXMwpSC4QL|_E?-eQhbWnKOn(ksyQUy+jl&J;s@;K@TXGIuI{d_T zJ5Rd3n^ltLAGERk+U=2`f;Li2%s_qX5g-s(EKdf%9^#x%9XBdaS6x?A`?JDsAIz!X zqOrAHxveD`Ys#0d&D`ps@g}w4jWk(n8g0gtsh=)*Cf>?GXxqw>SV@jkDbS6ip1ou7 z7lgFEb4rg;(OMLgmSX}-xIX;6WO_JoK-Eco}jk z(9!;9?HPVLFt02$_1jaNk!L!7p{L4@j*5@9fd|Y(wX!{M!zbFgT|Vuu8CUN}&pvHM-F!SYG-9_mn$$LG(| zy^Okk(wpX1eUF~vxXTNQrz_qqJ%1xk?pHgNV;cm>o6l!Eh5+1(N5sTkr!&IuU952?=| zg?e&autyIL;w3y}8)wDJ`mRCv$AxPQco%p z?mu>X)OTjbE%L4hPPz81E6WGF4%Vz^vXA$^Xy9$f0l&I;5D4sZ+nU_*CW$?tg7oJ= zcDrnL?YxlKAMg{L``3ewlzF1Nv-H?O)s;!?lx?SWVd!@k`pLA@rdU!aLZA`Ck+Yvy zWdWPdh9}xx9dWRdIL3MF^0$q@ zZ9j;fA&zT5hjy!=X(KE4%e+Z&M^BYFjS2L_5$j(o&7l7P!bhX%Q`_D|F6^|EdePjl zSduxXmv&^y+T#F)Y-BOybgdl&!3+uaI$w*tYj8FH01;kEa<9q0)u-7WJy1Ez z4`f_d*T1um!=HlM=ZIuoM^PRp)hu8aBHd$X?IYUYWtD(0f<`iV^sk;<;fA#&kUqbs z+-rJ;#C~|UTi_%RE^{G5nF+zc&uaU3_D&uP(zHJj+&zV_hL$-YStgoREb6)WU8F=g z40r$#bJsQVc@1h3%qhG?{nYO7v3@J#>nx76Fc))b%a={`^*+1v;3zzR6&HX900HPd zDL&C0K+7>zjYdnc0YLhi`N!gC?JMA42V6dv;mH30weQsI0T(UiH$(}Y*(3r`N7Qv+)k1=ILFJ_GOHvRZ#R<=1gtlf{V%Tiv5=r;uRS`WtYR9_u44_OyU0k z12MHAv3a#sMw{=fpUC||@t?==CR^y z>92Jep5p3uEX}y*o})c5bIT#lWeiXilsVZpsi@_Q3sgk868jfRoP_-GOA0k$lcrM zDyg@7pPp04Uuy6w)o*j@6-L&hk)v{aytdQV_-bv44jDIh=b-#MnwkqwJ0V+SYC87) zYRh?14X||`Tl_1P-?@yct(K)?07JpS>)SttH6fPZY(&_fPEBbbf-oN8f}igCeSPV& zYEnt%!wP_|asAQjn$ArlH&R=o6ooB;W^$x<9G*L8n!9M|@+@&7X;^p3BRu!%^{Eyz zgshon10VrPlbd*h#OkJ1%M_y)ypZbVh4- zNl@Sf!3RHw>q`%Y{vcngNokP;W3#0z@GLoa8n4PLI^*@lWtbP}G0>fL@?cY(hCqvL9 zhFQTFNt_%(0X_E>EW`Vw-o8ZmL!@h;5WXlybEeuprKnFQ?v&svXXO$|$AwkrB=^7> zHTq*Em4}AyE&LgyOfKQF+}C$1MlNpK{bP^zMgk|G75i@maGS*9VJWY2AD{G(=YJi1 zQCVJFEEXPLzNvNSwAA-A<15)tV32c?c<4{*PhDQ>;R{?8aJ(Fx8u4V*BejGUen{z` z%8QL=;o;79As)Pu>tE1|2^5l!$NA+vM6d5Vo~3&&r0PQ;1Flr@T*c;}rOhBW5`3WK zq2OSCy=%JY*jJ;=6AN{593QODb=eBrb8e zxyC)a{uQN4v4mTZG+`-Ca-;Ff!CKz0;opuQ@UUmlwHu8d=6jSfM`<$?9O}whFuyTU zbB^`*{rAM*2I;yRYF}d1@2?s%VY7!zz4Ih;K3_1jLjyf|IqmCTf7tvNw9^@`n)uIf zMgzKFDE|OtX1A>L7SR=)%Ce?8=bZYQ@M+>=qTxRvDLbd26*#+P?>Wb+a7myla9Tz`4ogZ<-HKj5Q(7qx9Z&qw%Yq)yQ#+8e8#hXud=mIwrfJ%Bm^$vSZw=O|cEEX(PbvrU^VCNccB=HwPf}}= z6s0EhJsQ}h2r81@pa0PNQ&jNf?xh;REsFh_Sl}zOhCOl_U0Z|fb6-7tTx9SLiG8TX zq}_!k7?grDj;)t=7~tgNK9%-(@O`bEalt;Pb2Lkk6DkN8!2qZj7_W#wZM|Dh(X`D2 z!(JV<7MBRJY7)y11L0X=i_CxSukU}+Axme=T#+^ON;h8`;MH;wdf z0o%lr>iVpaEJ&m}!xN}?mQAPlQziN17&xy<__OeTT=*la-1u_s;<|QJ`xVu@6%q-g zX5WVAXu(sCQLqk13H?C*mcM6dJ{{Pfh(0@&8^!v?xb~N>zMl?BVELxK{r>>qAI-DzhM)Sz zs8Dvpr^|lw{$ublui>`2oreDavP%;-&{RK~yd2{^Zs(q(p7qK2lF->}Q;mcP)np$> zO#c8{>-=G&UFcI?KoO_%lpi#y2WqH7thgB3Mmlp;d|r@Tw0fPJE5eepD*_Hw;nO1| zkCm~>JcG}t%toIhx<6vgu`;hu*~(uItLM4PUg^sO5rRaExo|6uK49#1Gpcl=xfq`&2N7trTv3$g7Mv>Kkbw( z6#8;7X-T_W_HtS@m1*)lbpF0ZHl5-rv?)jK&CRv;QsM#Clya=Sw=V=|uOq#8UMum| zrF~^#rr298g|)n&YJlT(!P+EVz_ltT|CNLG5y9^$^`L4W9RRVteQpcVgla7P*71n6_E$!4;f+Hbg&~^v;SJTs_96con@6`O80heO) zj8v-5@3s3G_O^1%B1DKwy9ElPC!f$)duia=+Q?l@L~AM9oSc)8GJUzNoexH{S^T*G z&9+N1I8E)-J;@&3Yt`eimi$3$CCf;x=u5W)<;e<)dVANCipI4q58W~z0--`4(-5xz z0LY8OUK4>;Ep+%pEPOP_^}+t4y=%hyJ*-CJ19uZe9tp5`jMlzAzuMI8s54X+M-$MmfE zXO?f?&O#1~2OT?)@v5sVCp&+5dh^@rd(=#`+b=cdF&YCqF1)eq+=RZ~nbyTwkxuAoU=R;ntYhR(*avYR-mkIY{sPBl3))+f9pC7FHOHPeWZ5L1 z9`2=I<&S?i(D~BGK=EIQLN1S_$W}!qXP5VI;PgIY;ZNa{UbW%BgU;~=@lL3#v2c;t zM$$e(1QPOXUV!#FuUpjoS>f##@pQfIsp_o1C8QwBHU}9hpoCHC#0uC~)^4MSow|Hv ze9rI^UgEx?^?^DrHKWG;=?CDDExED{HyQq94(jOwWmp6?>`F8JV(zl(Q(A$Wa9c> z%kD%GU8TyFh!n{n?m0hG+w-Pfi#z*MVR;%~#={P>C}{KVyZThqM{637Gmtte3=e$Q z9jth(NYSR-dvO(`AGs8+Jj3V~F_%8TEqd6jMH+DZ^GSK1IhEisIEsm3VJSdn70JJqkxq{Ohl)PR@mv>AFF(wcDfLB)^k1V3`%zqDj7^yYJmSdY& zbQw!%*ltLgLC2WfGbd1_XYUI5Oy7s{{6u}O9-8NSHTj>c;nlO4DAlu)?$oO5hwG+4ZlZ!)5WKMN_1Y&a({et}hVr z7?*bY>UR&|j|JZ08=9m|qGD(Li|5^1+(Ayz2IoDs+8 zo^f4Va>VMaaKXI@t{GLWP43NON{vN(CV6bX3p_B$P+O44saym6u~;(v9Pscg=_IIq z_MX1{SGqRb@D4q_Dy*h9$RK`oRPzek^D<|bQr^h%t6zq?HH!inWIydMf5y7|9XiWM z!Gr)u18D8|S3z(i#y0`{>n3Q`&P(8TCjeJR)+IeA&QGhx4)H}h-Bd^lq5{A%4*dEW{VVtZ z$S&egvLlY%jmzq!5noVvyW!V>eku4;>%iVV(c#pzd)#h{U_n+Nb>nrzBd=9uAdg!4 zU%~$X@K5a<;a7-e@dv?QiQXabn7C}cv0H1{83!R5WJTTwZTYSlW{NG`_M?{jSSYu# z|Iz(mhFIjrV;uU|a_HS}S|BjcoM&Iu?buZ9C+WW-b86-VhLamKFNX=9yb< zuLZgsX1@kMYR?$jc)Q~li5*+chC9P=9H@R$wyGjA<2>P)IXxH(MVX{#t&mTKm?%*D|#{_}Y zp4Iy7UNVZK<;SQ00A9XtgtGOCtt?E}yBB1;v-IyB{6n4t4Gf0{?ApBFUY1|xNj!G$ zgih+d`9G%>UP&N@0BKfC@DG2+p364FxlY55`OoyGM`Z=Vo``Yz*XhdJv-s)nq3{Ro zPx~ylk0GDNzYgLDRorB|vqszYfz^zCx140D>V3_ALh2emp{41%mXmvI(A?TQZUm^p zcuZ_oNRLgRZtgn_dRO%2CYmkI9m{9Zzdt{0pMusG)(7G?i)Xg#FeB7TgZtQ@Zwb=%8DN}o6M{x~`A<*l^sip=Yyvb# zR^nbqe!tVF zJYe-uPVA{YyB>$FVq9ELuId*$wxUDNbmf?Z!t>4)4h4Dgqk5drTOUh@$4$^wXz1kb zMK+^xa2h|B3wb&P$zlgMB=sJk0iUH|>T1CtwA(y=UJ zeN#|-mHC0nMo&0Edj2N>=s*|0r{PyhO72||j%$OdDMt+5=RN%v{{ZB@LdwAr9_D;B zBaNYeB#wu_O!|7(j5g5Q**2xC7LM7@Ba9LrY;+1eyRqO8ek)o?bp0;T^({z;f-{KX z&&@oT;Ya%;sUo@SYm3cdRlUDOl3BlZ8V{9F0rG_&gBd-^u9z-(-16}%mL9Lwsr+kx zw*LTvQx{*_muRzqkgj~Vfgunae!isFWvAP$FyGz7jKQZ}akFq6hTgY+f(fzEdJ;0|llwA)6$(ykziDG!?k#4g)ZMz{h+P)B0g3e;Paf1UJYp38>Wa!yoeAeD#xaKDEFwuVlJ+k_gpWR zDpb;Yo%WFg^WHMtx=9FfxuP+RDmcL|CG>E`d7_jD&5%n%tc%KsO#?K zdCV4)uq(r~V}Y?x8UFxy@sCW@$SyBrEX1k~r}_-^6`ySYwTduIVUPfz~E=LO?gvVo*RpLMAF*~3$y{i=mtMJqW27UG7|D0r=qCz&-4|N*Tv-9 zCLg9T!iv1NR(6qnuKoO^3z44Q`1SYbDtWJ=GN;JBEPq zjFlPr2*y|z=mvh0@xP2TUxoe|k66}aN4U8ewzG(VEbaWl58`9f>&1S*!Mr1fp+oyq zGSMxQ*#1B9d&Mlr9gqJ2R``Eey(cB|(LSASY3ipz@IH`rtybnccp+WBWP}7x%8?-N z*aZaFfJ@^q5qw3|1&)X3X<8(W^GrTlyOrzvzxn2e*QxEEal=~w0Bw9pzaBF2^t)}X z@@;Jo%Wo3Kg93_B|05EiITEnH@`GaLC<^9mlf%ee1>IE;hwx zmA<2c(igUbaJPmyE*-YjGSZnJgn5f$C3R&c0;vx9tz0=~psXczGXOyBslrhm@ps z23|oU(Q{ucc!T1%iM)Mc*Zv{Z?X=w%L7(jVDHS3ku$7A!lizv4?4Wa8WB9kjHZdoa zbemM|*%nFqmH@5~Y#RBD@5DN?y*wl=yPwb;1@vme!A8DuQ<_?Pt7ZD0@_r%wOYxlI z5i4mnj&`!y

A0eCz6YwpDiyiK=iv`5j2oIjo2^=!F%u;qN#ew00 z=k>3Pyd~rB4nubxz4e!xpl?Gwjy8_$5wMIa^uxklA@J>whxD6!neA+z>OvMjFU!n$ z0c2gw6^X_RXPz)SSH5lbE8&-RUVoyVi9x_i_eENrl?14>B#F|yRDb6I+EtBv7$=fwV`1|3NsM_8!(N)0e zFJf>9PO43JJnss&sJ`=_mj-5%SB@G_xfuAbXcy|ZA^%e_Zq z&3Q5Sk?@`m-&}a>MhX7_Uu)Ot*YvIJ8^>P?^=03s__oIX00$ViX(So^6B+z#FYR0` z_L^q$;VjaU=AIr)gCrw6%6HpCtdXS;?XQ;pgx8ML7-8UND#82Gv4dq0IA3^mUiT{sh2z*5v4eAhDk zkpKw*;g0NNa1ToUb}U_WzY_hj;fB_crIC*Cpy$kN43YyjbII%PU$g%Jwm*!#3*wK0 zmcqwX2?fpUcNWh70J{5B2p%_kqrs#JrJaf4rua9gg6t3uboUfBvu6Gk^I zir6dVk$~H}anBuB1lP&&UMt#jD7}x}JOIn-(8K#_d`-6e?Xml1`#fm+Pli4n#d!0@ z3rZvNrFT_Pgcwpuz{YxJy{g+(u)iwWecV?{>KR%o6~ig+Hj|O>Uw~Sli#{Rvk5C>R zxYb6PX?PFWmPuR43PHjq2>|`vp1H+c@N|C`?ll{~2Y4paQj=C?7MDL}XOUG3<8M+9 z-$UVfB`t9i#MlbJCgcr_ebM($K?l^=>%N1j z=^iE0Ej8^TQ8lIXYb-85iZtA1#@hh)dR4YT4NnLh*?0yr*ejiIKge%dh?J3Jn zYg*5tLh4(`A~_=guMejMF=JNSutq+G^+&dxlU0^wdJ&cb^Ww}O3C z)CMu)9|l2x0|PyjeniXNWQTx%6~V98-`gwTrJuwP09^QsNRK+MlBQHBzcVWG>U~FX z^ggD)8FX8l?KTVPE#oFse=6o9(4>k~gXnS&4{xP@W1e7rjv`#Y3)LUo{u%K)%rfXz zZ{A+)y?@}6*=ekraE>9wR>;zNjl_R4!mP!nv`D+TzyzOeohzlaz0;$z)wM{_KlY`e zhSn8eWLXO#A(yDYQZs?iIj(Z+Ubxw{t&-kW>T+0*VVn&9AB}hri@f=d+wk~`a8$I} z8Jg?I4ZN^gf2=F>p1X6=ey8-LwSv<}vW{D}DypGECl4b5_eZy{psOhaaU$K{;wFNS8PF2I}_-#v?#-BTrB9J?jS~z9*sGIyEOb%7Xpmt#|yZ{NLzv z8r8+lt0P^`p=5}D?lt?UgZKdcXRd13hoz3{80};Eq>KoMoq-z3EA0)tAg@8m;2t~X zw=bcN*2%yiIT#!cr;q;tU2(BnTrJ96*thQ@Wht}<+{?%$9u7$8e=6$3SLR;wKR@CO zo>)vu<#&Bo_1C%8$pkq^GMhVy0rJYDKbaz&5F2g?Zcjg-O7t%YTwdGiR#9F72?0^I zXXZx8X;|U;8?b&;$79ZTxV246>Khwtm_Ev|N~Sqvhy_APU?g$DQ=jheymAF~8a3=% zrQOGrvqv@zaBYxnQcCrF{m!GOrE=yp)S&wxRm0ebsq1v#PU~BpAB$|Rrts#Utjg;x ztWw7q0)I4*J{`aX>Z5c{NXG>JCxD7@_Yp>Uxu1)~4rH(E6fHw0q@xXYY+eQTbE-F!iC4TYmY35^xqS1efvEERovpI&RiqU{Syq4)R+>BzR+ z^pkg_2o(rSuKxp ztBw6nUALL0m(9E*attcxk8_V|#ng2#IzW&d^V_hlb4|Xun$@PCi;JwVOnt@Z27goU zTUvFdNp{I#GtWPrc@<}8%5%6Vd(76djTN&w#s=o~$NvCcu4z6HzxapZTOSX}GutK8 zvq|Lu-)FUrOFR7hZUet!Yn(S5!I=Pf5w-F z$;FtC)68;amSF3YSl9TON#L9ToRQT14-MdzOiVqavcKSdec}#hUWQv*avhR1I zKBw_Ni~J$*XTcWQyq4KWm2Gs(6(q@VBB)ePTmg;8`jKB7>DRi)#9tQNc(dXa*_uUf zomcKI&X(|wf;jpdbvf(Q`KGh+X}%zM;^)P_CA|AQRuC9;yL<)~$iS$PRPb4Plff;| zraFkcPi3fC+321Wvzq1$c))hRh!s(iI+i=Tl2mNVlfi7u9DaP(x33su7{Lo2 zt15<71EFSP#uqrxZ{rV&7SMlY>)OwP<HJBnY2GjK zh32(sV48iU^q7j$0Cpm-HZFN2lg@gRlU8ngH!_oRXCv9%LXb!!xdZ~TzTBf8agq-p z_w=uS3r;wAC|=C<@Eki%l{>X{+qaRQr}%q7hU9E?Yk3#so>i zx_lb^vs%Y*1)E<+scS9DOR&0q&`K~HT#cKGu;-k0u6=&hpxxbBYSw}$%Yr|I5HpZ^ z9=v^XTUu73bv}`60?3ISgr6%rF(FxiAZ`1q56pi`oJTz4Yu{7pVV6gj-O+wWt!b8V zP2r3G01{|7Flkr1Y-p0{me8?|kXqY*;x+q+%U%vP{HjULK;t#q_+$PNeM#Y4$zB_h0NX2;k0-g@Kp#RsI`gJd zqseiYkw^*&1b*zG;=RkmS{0T3v1oJ+I#f<_;FFHr?>zqioL9y^9Xge@^a$cRFkGt# zCu0m}?*1J`eXa0%7<9?5@AWBd#P-r{NNy+HY*))N7E+lG#A5+~QIbw@K=~}rEo;xA zrx0MFM-Jx*u5ToLGw}1_R+Bc7Z?0+&+@EGyT}~mHxXi zB$dOSJ+WRd@oL)7Sy;GgC8|Azt4%aD8)JzO(R;QH(=(;j1t0Nh3T# zBx@q=3Vu~C3gDkye=4Qnui5X%@##?7+}K4LO&K$Z?g&(QM#>M7BAKGRzctlOK@=NEpuVL0)e+ zh&*9>FZ8WX#wxZJj*W1UTahfA@~v-gA_ChG43nO7*PcF))IVfftzOnWI!$Ih4%MAr zWwGAIMvb>1ZQDTuxj84)b*}IJ8CSyhH}=|wp{mM6G5LN(5u{OIFgX~>1oz1~?@q30 zrM!njFNHYhuFwC|{NM5a0E>K4;=B2-bz6tj40jJ9nn&|Yl1Ku(2N^gx7*cQtO1I$e z6Iy>^&7*1vCYIh|G&yc#R#F@&IKt$T-0|!>*3jT@4qR!{>M;3wezgkA6wZLDjilw2 zkV9-?hhB04TyvVs(Dadg;%!>m-^-Db86ylb5m}~K*}3c&Bzg>2$YN5DHP*-L95aoS zYtvNSl$u{7ZsIYe>eelHH`!X|6D_hu!~BPaVgSZSV7Le;??VUN87(XL5AE7g+|>^z9OOW0KbTNC1*Z z;(fkiOcd^oqd0ijsTn!1kHpegh|{S{S;uwc^gh!Y#uoPUX4aDTZ>sBkJrB7&C9AjX z9q@ADb*(Dc-^&Endd{39V)}j7T~~Uy%o}J8y>Zu|u3z>{)2Hz7!b{C2T~g}u>q^z{ z^!tl>NNBC(w{hi&G6N)S6R*m02?e;#T=)<1XW=KoOMe#lzv33R4W_l?yV)-8VU8K& zYea`|OK&Q4Nt~%HOq(#o^Z;b{zq3bxJVD|whh8A~i>kvWk$L02cJE%bwwZPxvRnmN zQILRFD5KNYp#=Vsk>jw{RXVcTI%~Q7*PSe7Iu)?Az8a63-9BEYZ}!XkkCr)32R!%3 zYPMm%xWhitv%g=$w5GNG&A50jt;7?iH!1#qLsAL52*@41EAG{0D5njN%ibNu^3O-+ zQIg1B*~@8j9#zzUI|J`u&sW8L66e6*89Yy*LvOJX=I$kpf!izunGp|g$N<{I&>H@X zBXv7l?&Nf@%un0j;OxTk$KvLR5X`$Ex+9ESN5o|NNP}tjUwZj|B%0_$Qvn z37AU{QRz`HyVr>B~_bp4G5 z%`d~%m9-ff{mL_D6g&)&53N%WT0{cJ0N&hXbJyy7R>N5=2y%STKZNoB0PFl~JtCSv z-ry0?3g}Z-(_`gvmt9H`)8?Kqzhaf{PTM6Uf`~{mu6Qao6*xQ<(yW6#{HKil za%F~)ucbb z+Qy>ZBwH9mHm7+lytex#SYuIdoxqmLvoeySJsP?(2mB-2?0U9~a+el2;jZA0LJI`* z7&KCC;T&U;@5dF$C4xz5rpGf$1St*L=C|AE1nOi9cmpeYfmL_+7e;7 z#3nU6w#kpY0X!4e*woQn-`?9u=`n^_HyxP4Dum~p0j9r;6j<0^V zTN$0LnTS>eQJ)-ua(FoOKT7OxJW+9^*|b)R}xC@InGvsvPk*dRY^&t;dJ-& z`5YgGya%CP-bV5W)*D#M&Zc;xmSxW#PUOe@1d@96ucmw<;D4~$%?^=a9=WQ;0hz2G z;UN)1PZC1v$jva?2*8y(^0@-IFA3^8cZOsB)k}R|3(3rpSZfeWV=jyLRieYAAMYkq z)tNkSmYPdkYcXmzz9y8t328QS_yKOR+nz%!y@!qzExe#kC)}$(>Sk4@wTbqEl)s|v|H%D(WtV0vNLYh zZy(*U? zXsNU`50)c7%%dH8@m^i0-@U$@eWOgu_*RcN&nbphUrpP8TFV#r4+Kzk5x-C3$WwrR zmFc`3rqrK9+{4P8BAng&{{WfoM)ucRxV_M|FeHlQVO41|4003-vIfT+PBZJ!*9B>B zeCE@OR8N%*&Jx+0v{J5o_>u-p!u5H+DnPbmY z#^u8S`Eyl62G!zeQlf)OD@VD~=;@^C-YJ#|;1^a67}~6P3vjsOBxJ5g73Z3b`(IxO z4op^O%LR^3;Ba&A$LU&f>V<9_QXHf~LXvpIY6l;VYmt)RgXL`m%gF<-Smc`YsA2VT zd+2=5agI^tN%g<^ey330R5K<<*xUk1>x}dHk&ni@8(m6R?Zo41NE|9IIaO?&gO0wx zg?aQ>0%>KFlF?&e^})^$>sKEAgPqHSj1%vZ!2WdWQ0CnoSZwMEIc&NfnA-G{UE4!( z{*#9{5@CwDZ{Z|@FhL~b8t(ife|&7AzqN^`yRvs7NQsq%qy*oR4%R1YZpHz~Cy`zq zr`}6Eh{^-p+yW6#@Gdy~0LlDo(0noCID9h<)~aQeDV5Su8N*AsVX>c-W3eN*<6b^9 z0{MN_sot?3+6~j(`>)~G#XlKnTGp4O5-!M?rKPgK%K*8Q60peZK47R$19Ap&zy$sE zrudT2;&zK8X!kJx0B`B(8{9;SR1o7nS!|KLPZ>BT@fG+}t9(T9rInS8`gHSHMs8xc zhT$cX&JtTFk8;VJj02818OCwNePQt9_LKO5;n{7kFA;Thh1AP5IJUg$g0ixPjzGiv z>y!QASmf1lIdypAD9hdInfP~zz8S+frBaP@5MRc8SR(&!_=4cZf#;%H7778+eg(s2I1a+@Q@W+p0)hr^sTi7pcD#C{96 z)o*nDa3#DKYO+UdA;KccyPwLGVS_0E9Bv?<_2xJ`xXL;oK|>4eDJrz(sr>;9@3a+Y z*p0(D&q|s(fjC(k->rN{;SY@#+V6*SPY~$Wt2A>!o_r3*Kb>8nZzUZj?7#|d1rSR+6yRTj^Yl7L>ukaT*9pg1~!ZU84mHd zNgf1H1Pb1EtaH(qBHpg+;1ud$<#3ooMle{s|z0nc@KkI?0yuOYd#*;Ex^0e@1~aI zF5%CYF>+K9j1S>F5zyDi(ZZse{&9GXe91_gE2}Ixq}4`quPtmDJivByjsUN-8nj{*7ujlK*KeorluZLF0MVjGteKk%}JBK93GtwvIs-Ho? z^slJ=H~#F0%)$QfC%35jFu5L z@*wk5VFwsIAH-8URpGx6{6O%Qqu}2YLT1zTSXvoW@J4x8Q`wZ^l=dRLm*I!)gYZ-1 z3PGdl_i^YN5G7xdvB@as2aq$7o;%m{ANxyw&dc$);f3ad98j-_ zw8b}CRmSn=!*HV^bJt{ph95)NSM#&u8w<}3>vF}d*+~|oYa>B@XEbga8B+n1Bn27j zq#O~0Uki=Gs#R|Xc%RwcAMvWpGWQC)RfV*BKJ68C3s_^4N1owKt<{;svmdA=pJ814 z$oq=Mq_3|kKVE-I=zp~I8)uG4ttXP+U^z05ho*cURC1h3dE|vb#az0hT!E7k>C*0Kbo=x4zc~qze@F&)>lH7u< z12%m}$_V!LtHGMt{Ha%Kk&q7u>T8D+3#}3D<(RHXe);>U>~&3R6wmf_V~lPfpOj;u z{CiZkbFI6-hi8sCA-GAdF@_FWIEV_&q+&3Bf0n~QU5GKD%+ zqWSlB=(;1Z)Ah|uR$-)A$uWxjMuld5?IVr>`9^;JLT>4i#eF;Ay$b72@dUTO*t&(H zU&#zJAKp%|n=6QtVDXj3!nBwIGJaA(&jUX_cxKWITPM3O1;lWLp5_Q&$dTjT2=b+D zkid`?LYBZM2M0d=V%HiTlWnELb7o3GDVF`N$$e4U@Z$y(>>cxJa(n{{U9hWYY|2<|(66;bq1^kwzP95wz{(XFTH-*;-l2 z@he7`!g|h@mXlq<43_uqj6TT}Y~;_iIDCLXVb0J;HS;(+KE|Sx+o|>W&JuBimhb{P?` z@Mjr3^Ij{dXxi_C^)=EpKw+2{)dXbx|GqmxKP7ll`KYbdy+DL zTKY-gVLeu;^RkXEgyU>PJ>|LT8n21<4NC4!PI(%8*?5vhU%sR6vCk(X*1Y8T5^AXe zxqZ$Vano+oyT8(uUC$%SfwTk%3yhP~kH^xg{{WhS>!6plpyrE(dsclXQ)Vu#|;o+&UxF@J^E35{+(=>%7G<-C~c}2DmeLo9Fd;A zYOboAq>9{vuCZr5^2B1EE+>*Ew6jybRof>V4V?A;E3r`3F2-*&gkd*5RrK{U?PUT; z8b;f+GW!4yO;}&GU(C;Ho6NXX9q>2={d2&tqW%^B&Hgj^gBr|j2A`%#LmP|0%A^s= zMISSee*@|(^h4p-?91@O!0T;2#i7@4pg=s!wN{8eFkD0i-1=_LKD^h^<=iodukTvR zx%j6U_~DghZPMp;Cceyj`Mr_(QQ@D0{{Rv^W2Z|uhBOPUQV_ul#D~jVfw-19U&|)F zcF*=i_?Y(p0BD;=ov$Y+a$d+|=z5F^qOSrlNH z?x6!EiDQz(qT}%u#dwSMZuqOFPvuMDtH~n_OUnW*prHQgMqo)Dy>rce+S+J(jF5vg z8$jm|{D7@Ev?kq$a52{y&*w#64Z`gSw9GJnNet>PD!mvx>GmZF?J=MP~V~$YxQ}J9zm6>T#3mO@8kDVE7T?uZy~5 z7V~*_I^Chgt?6CcaxhX%a>#r49Y=6~4g5{v4O_zABA-CILvMGdtnuAte(R)-5!;`j z$G0```Ib{WJh>*cdo%h|fP77%oZ;PEJ8_(C%?{V?_YT!OK_0b!wrZP}+A#{OV;ED{ z0CCt4!o4d%*RGRQwc8%sm5*fPk_3@PFbkm=+(7%of_dQQJ}0Kd91^QSdwkA0!9D%k z{F?TE4aBbT>M+<`&Eyc~cv0A*s5|$S1YrB|*1ktHv?;w0*)sXMk#(v)TlpVDTj@74 z6_ZB>;@;!;iqH`(WDcZ(kO)1Edyj;s_=(}0J9+fmS#EUMfN>FFExBCdcF=c3axs(u zXQ(yjdL71}eIAW%pl-Z-2~})Gw7y-%>M;4$nE)b40si(KM?Qn@El$TzkHgwlx2GrB z?cZsXM8ZfIu=~o&NmkwRkl4xh>&?M6J+3-5`JFe>uKs>U;eIsd(xaERJUXe}OShMq z%vx#_YIdS&VS6WYi6fV3aKo~YNM-aR@c{8ychTI-IF29{9l0HPbDG$maTdjOQInJ$ zWDehrJ_}}2)7%U@5ZE1YU)Fd!a)eT-?$7g&Fs)9dSx%IBQ`Xz0d6&e?Wd8t!55$PU zWN57X=QIGcksNi%!5>Qd zPvT&{lfphDiq7qA8SK=%NS@A4QVNT#>Qi7kbZ$EW9%phHaUIZ)eDla~M)P zue3Jc0l^M7`ihI;AB#2L0NZL;8aAUPthctpK=>tm(5w_ljg?@eW2QP+b*A_qTfDv1 zJWnj^YYo{bZLmYd=cJQuZ(Qvw+!8qCSCys=S{>EY1lq^vT3j?|Ycz2=A)6eM3XXk9 zu5`6NvOJTABil>*pa0e8{x^81;x47H!QuY^5Vh6sggipR;==81)>$px)ND)=sU&5y z8!Hf0^SiP5zR=kCT3LKq;aBscy^>o?+ae5VB4Ul@Oo!%7us9&FMpb2O;=ca?@Gpvf zF=_t*3Us{_MX|Eiu5=5nK{Xp4LfBlNvKbZNl%PIp@tl?8E6+UF!+#Jp8x2!dp5-)z z@V2|=G^(*o^V!}Ya-S%WvnwGbO0zH{Dsh2a)ZZiJY{xB(sz%S}=6M&1>^|SFl(r%^ zoCz&w#?wCK-it6C39v$zz{?JL=Ah9cnp<+SrsR)_5xfook?!`h5`?}eSAp3tzzISbt%`^dw;r(V_9>b^Yi=CrojnFTK9 zjaO2!mNKGNOpWnK2}2-UlztodNFz1M>bF{!g{rl@a&40!BLmAQ=so>;^%aSz>DE`a zCsNbZqMc41I4Vz4aoBnuhuHPwqdQ3{qtdH}jMqFFz2ZFrT_;hKOqry3u#&+c0C|y0 zyQ6-8g_MKGemLg5{_Y7aW?)Ad@6#WM;=8>c#W(uKn`hx2QrzCXrV_$cIk<*A^ACOT zobV4SdLBrm)pR-SVp&-Hj0idY5)KM5JjUa?whyLj+MHC;$ws?g!W!Ci4Nlvf;PHFG8MwB1@t1hf7%b@{(bX_Hv^o@hnBs2gPVmn$9& zQmX=z2^S=8DmXYf;=V7J&56vG#iDQa2?TcS>~U4rNuMOSJahP0p73ws=yYJQp2DnZ z(~YLOo{OaTusy6=UZZOq@gox(N4ITX(oo<&pTs?0)H1Kl@byjR&zN{ zcNX3H^cCY&rsV8?p@PjIqUuF0dbj#rohE~GYvxZi)On6L+dGLuN$2HZ_gIA>dgmQY zNdfa--pcJ5wZbFDsV3;wSHLddbQ=c%1B?K3ip8|KisB$7-ENJ)d!w-uy#_#4 z=rVG9*LS0MYVT5>Hd{8fmI%DrU5;bIj1v6{mpvDNGr=`@iE>l2+{Y-VQx{*_bUR%V z;tezVE6=lrDRh}9GfO5!S5FWOv8%=#IV2EB;I>W&H7AdJTWeuwHLb0*5?^ag=TAH+ zxJdW08y6oaaey&{v~$*{xYev|^t-7ci5}gZjI5&(8JUBK?NE|HZJ}L{KnH5^d-HR7 zb0ziUf$lCOEZcYhp1^hha4Y92(2qYfw?6u%O0{CuKAK;*p-w$oXE0f<$O0x~8*U>3 z@L3z5x^cifXCBp)d$u-r$ubeJuW}CqKH{&s+szup$P24BUmWrV2hd=V^)yRi8G#6L z`(isy$hUbB2IqGw7##fA_WWz6vGEqIqv}@I zHrLPQK$~MRxkil%%LTz5eGdn?t_s!K)^GHOklHJgRUex?QbD(Q_uZJ}on64X6l1O~WK6s^Jovw%FI~ZV$_B@Q& zN2h91Sjg6_GUh#zka+pNQIn2WoaBUI>35Ob?vfiAqj_Z!qbo(6h9C{t z=n3Z-88x0;cvSXH=+7%W%V{RDG_U`Mt; zBVO%TMt{3q4=W3dl_<)*m%C<-9|m|U#6CFJEi7~!IW;TUV_6wcWmE&SZ#)GV9FlQg zpAHehu={O{V(G{E_H3w-LkT+grjmoUh6{5zrdz^vfCV3FH7fd;Kckh5RO~YPULq z{`No)z{dmIJ!{ZX(hD)0Sk^r8zytpPuU_sW6qDtOKMtjbd&t4J(4a)k&QGw$dHrin z*3uY{`ZOUhd2X%wpXpbHypkN8nxE|KI3Fm-Q(O|P+SQ$2%duZ-;kTUe*S$~)o}&Za zwPgl1;CAHqs)dl?j^6a4BBc|Yx^r&()Eu|3TKG5i#`s#={{V(AJ|g&gPgd2eA}f4i zOfx~ejc^>PHBR6ak2iOWVq^5!*eMm9sd9e z{zuZk4Wrbc_?x77CfLuXTwTnjG?@Zi0~$1uVBiFjM$CJ*fWY!F4Ss=m169y2JR_=j zYe{+SZ>_|!-NAPtXJ%kdLBfP}WyuGP*v}RDQ}9~$;!lV=XNoSSX=k_AtWh0-4Y0^F zo=;UhJ*)Kp0O7C1ty5f?px2mOS;Zd9*(3^JEU$%?_~XosjrrqnCydv~RUNu(h$YYB|T`KM?OiX0 zH0>)?v01cbU+l=_mOFiiDr1I5jY5&s0Js?KUX2c)1*`#MP>0)(&cCkkxu-oCPr5(N ze0EUi;wn;?*>CV?fqX;ogExonJrp!mDM zdOWszBg~dkT2FRvQxIa`5y(95PnJRwFbUhvGhcE1K)=y!t=dz6nxNi+=cWa_qE~{)}o-^f01T0~WNk4JF?;s2ck_-Zc{*`)Hn_64Vh?W41uAS6oHEdvAP9Q?77 z^D*T7#C6H9ojh0JttUmd)io!!Dziw5W#<8t8mJ8-uLlfs&pE;MuISynois6&;Rd>& z|JLfiYCnfwFoNI3{{Rs*e>X?gd@U>*m4>5W4ZF{z%0f>B#WB6Dq}t$~N@O-h4Ss8D zJ}aBY={~W!Al6b}I`#qwnv;%x*KXf?VI${EkTa4ofg1)x+#}yf%sS8PsVTA6XHL^9~y}~G?GoHNhWOW<#dTi-Gu^XD!IluI6aMY)}t2f z_Z~h;nZuUT-5w)zsI=O5+V9jy6Ui>(iUJ8kDUhJ)f_AtAj!rNutkE@bbvnrn&`DG# z=2Yv22P~rsP~(xo?m6bQe0kuVUqsODG`|(;t)bmsvA8Hyc|T~32&9%KT&adtAhNIA zZ0F$#o3m%F zhH|9@SDNbj#_=z-`PpQTnBRlE%;lcYrYzr#XbYNO-D_IT4uK4 zu5H2l!6XA+Nje-(A_M!2P@H}BLJwz?B_M> z#X`JWS~d8d0>xFp%~PoPp!R*ee)HwoH2pThbWKCdxH$RD44^A<^7HqxlarCp13hbg zZwdH2P|<8P4I@*U8~J8v?ya6bF=9-7vIziObAVLjoaITbirYu{eA+=)lKV~8-O!-A zR7-V@@Np=8tQ(x+RPoWzTB~`f_*Pw0Pti2_=Z?sEKiVP*!C9mY`^Szkw>Vq?x#Jz{ z=d%j+Aud%77h~_TJPsbLJ+$iT`ZLR}d_8)Nc^#-*k!lM`uphXj4dWxHHOrAKZH3MS zd)J9?dO2?+l!kRH=ujm#d0EY08*zpQQMMma(ydw;kj-1M~E* zOhs8s_;EhZhVooC7Mib*t8XU%03%~V@U4xC!#(7SaU;j(D#oFJB<%u5aq4{zJ6Bz- z+-Z7Uy}b8j9W7mat0;!Yk(ULYQaUDh1RUp}uN|M_h3}RZNwkUwUAUT2zGd6pPespu z52kAh-&eiVu2|jNubC!GJdfYhlh^PB*ONR1zPZ9{tVB%~JaMPcl*f z%P>{wrO7RU>Q7VNv*eWd>=Wk+$FVr%){T-qtWp?P%#pCGD=yVh+<Y@5t{^J6CTkQ7x<7NV~kWILEI+`qkT82rcyO(k?ux@^U-k zsYX#&3}#tMwMn-2Ms1a)mHvv_vYB#C~=CCj3&K=W4smB%RH93B`{Hn$|ZS>JE- zp&>2R5i(nG#`E%%?8iQpYR)Z7NVZ)=O>+grQGM_M1y492-A- z!CFLfCtc{os2=Oni~(BdEgAE#F0X@p@prOL{=L`8gj$=}up>723dLk%Ncp&Iem#Nj zPa0{zvYr-^7WYqL{#gW>V<#*_jDpB}9-#4@Vzc(&=~r>uUBF?Hl|ne-WCY|f$;UO@ zSw^>y5i(XX@?sy zYYLIE(N0(BQMhlFxa;XuWIKjBFC0~=k%27dgXvV{QMV^J6|@quoY_iLg~!jx>BV8( z2%~?MMn_><@-gQFp4CuUNj#$?>P>c2X)R7UrtM?#`}V}})Ot_F3)|^Om1(KPZ+OV3 z1>a|tjP@BqPCJ_U9uy#Qnws0;Vo}TSfCr!h75KjqB?_{AoBYr8qr&V&t7RB`IF%5MgIT@EtUPE zgiGlzu0ZUoJ;aVN_z_->9loWi%5C)YJ#bv~2EVW}Od41^T;IySBmB_gEL(ZDE0g)< z`I-L!7Vos%t9xml5^gQFG&04XF-dS)eqWfWKz9M2ImZCk&zh!}ss8}NOJlA0b5M@k zP`eXLWuu^NqBl|d=koLAu~G7u3_1cciuR9)GHKoww~WcEEEkU%V8wxTEW1aR4t{1i z1B~;InXfVM#<6jwcwaDrxYuHK;1PeA$?QuIj~x&^X8^BQ@ooAeQsT`h|hi5Zg_w zW#N&4WVf+FlEpw$OJHs7&MWE96Zo4*xbVX0U`uypr^^@)>H}Q6zwaa~leak_ZaE4- z;}!Ey!^^QB_NJ$E9I?!keVWQy4iYy>w(TibwRYQj*4`&ythC9*Zo;m zDS$sbSD1Wj(dO2EAKqC-VGgGZl13-CoP4suA@b%xe}$PC?LC_wwdz-QHg*>BUR|(` zIDsrrABA~-v*WEhRJFPA;>;nM?HNNaR0pFD4k!lSW>sx^ikUUX*A6kgTe3q-_KYfCqeJ z<2-xUsrW0z7CN2Wce=&-k6qK1Q%*Na=0Ld14o7xw8Hgtbj1gQ^eicn~Pm=aoS*Ms1 zh2t^q>yyvk$EXAzdF@=Ba@=W>$E07|?Qr3sxJJXPXYQWFXM@nz^dyt_cQ`ThIpb!1 ztM=c8{{R_utGizxBk5iwvCL@p(W=}cE^vidl$`-QlY@XUwDVsec#GjqvuolJplFR2 zsMEO?@huP@)R^FEdE_FoKL&Hn%kU`b>41R&-`1>Pb_jP>46 zDlmG0E786XTX=uP+O+rjhMZv0?BsW5!40$@`DOtMcCXDQdBEU`=QY89@dM(Xt9Pp1 z-QG3B6BK532<#jESVt;~82!~z^6`OOUx@sF;wwhG@b;Z(G>aIImmpA5X%i#@$AC9y z?tnNwEAz}wOIs0ASa&~pTJH8s(EZN^#k6p^N_C?iShVcAzc$8vOV>30Yg)X~ygaL6 zp;=1Eh#UQJkL5Cx*9<{mnc4y3yo5#~$WjOg91QiYt~;nCwm~_BJ1PC)lWQNFuGS-g z{?7-$HAC!3Wq9qRS%6P5h|6sowvtac9XgKx0H4@V!TUHUE{EpW{KaBwx{`Xc86lDW zWzWmpaB6fjD+VWa&U2n?N?QhjkC~M*@Ou%F!Nz;_9Q3MU2E!jUcY&4d^~vWx)tvD0 zmW-+xsnYkL&AVR^kXAX7++%J5+J6&+U1g4>w)-CH28s!KI0v7h&p!3#s~eN^{o&Ug zYtp zdwh}UmNxG^mqY-O#tUp6PXi-82d#T2hrR@O$5^zF?OJiMgDSyg<0=kv#PB)6$6hP% zIOWmwh{|Z%O}&C=q){RqeLx1BlbhK?PUPftPEQr}*j@vLm$s;WNyHyY3|(8S1|3HI zTf6&@l(kRUo-Ieib6MKn`P!~G#~B~HI0OKv_**>=2t5eJd^~P1a83!DkbH*$8JHmQdoV1=tmWaa{86^Epelq+{XBz&cdZKFtn(FEaFhK@g z?9vBbPtBgS^PFFlQNucMqPzYU{{S=X{14-N!!`QVTx{;*<83X!HU9u4dxwN1@ho2s zG+Vd0w9-=JTpwk+$8K<$+DgRg-(A3Pax3f4gZkIP1K?c?!?5ZeA<(=`BWUC% z^6uK!ONiX7wX}%dQAHz_E5Pb8n)s8!I`V(QsMhW5?K7xpl3D5z-rYzyz+#vHEtjt2 zz-(;IQ;9EyS$Dvceg#cu9{T)oVBOW{O8)E>X^}BShdq>XeQV8ZWm}ndlk$wVdJoR4YMP2% z&WdH(60k)hB;=fO7nAfH*Y&fZ6q0=p^9Hsibt=kj>nC%G_@0(g-`Mzy>rQFoyeVuV zjwO+pd7+t+NIx+L8TH3n>t&J&(&B##TE%M)p##C>VYVte9oY@{4&j!-1JqM*JTG&r z+}LVY_Wn#-Q4?CG?ejd`k1_GW#=LDzW(i*_z??T#{MLl3ymsG!s6LXfLu7v&4EZ`yCApC$p@So?zL?y z+g^y+>3S3v_EsBh;ok^IRTX&T9Fy3A-}9zwz90CdHn(}Kcz47W*7lcvTEwyjZ?iOT z;Q3$z6d5s`9-MbI7MtOJi}nc(#;>hgNgBx|B diff --git a/src/content/demo/cropping-controls/cropping-controls.png b/src/content/demo/cropping-controls/cropping-controls.png new file mode 100644 index 0000000000000000000000000000000000000000..cb54a2ed8b88dd6fedfd63b7b4f499633b8cacd5 GIT binary patch literal 136053 zcmeEtg-={xv~`OVD5ba+cZUK6W?+!w?lx%g7AQ8r;FK13*8z$<6ez`^xDQsW_`u*W zxXahyOWr^6<*k#Oo1B~M>~qh`&c5rc8=NRad)_~+KjnVJn40*9WBPY!|MS?3;7!oG{{X^{k$UqVXoKbH@%{t8G*f)& zf56HkRFwILo^KP_h5r-h{r`pezjyQhHE-6{Os_j{6E++IuSy8Nndk6+V_fQ7{ASL&}$%fxz~$9w_jz~`0jJA9bj0p zn{%Kojr*z(+dmf9J0HJVJ$g0MVd$oGUSnR}Cp|^A!%jJ_Dr%vJPVcbcqe*-aySH$N#P4Qlb$1!2DYL%wgc(F0iCN&_FX;@(C4i z!oL};A;>#+zaaU;=P+IJVGh5v+}|rC_x9W3TZFE;k) z;%@fCe7HKd_@9vGi%cs84^pQzfkz7FPiBFqsLN-sj>fLhoTH@zcFgbITy>;k4+P$- zd{oE&iY9qp^CYkShMK_Q-ySk`6#&0+N}jiNkdLvBW|EF&kOw|JZF=foQqq1lxF6}f zYjh?5MZFZs{aW{CHP9n0hocZb;5>gRlpaCAcAw-N2Y|Lb8U#EY|ApKyv0ag$UEO!A z9AT0bU2AlRr!I81$2(L(Irdj#oz16%44fLsTJH(E zB&{Mx(!M3xb+ZO5jQH!7yV-Tx<9Ac8ibQRB(tyV^nl7<6s8`VH@y3e#dmE>l)&>zT0)B)rt;xC$(9C8EgZA8z`GPN7-Y0jq;NS18n}ITy>@6^ z6bu-Uytm_5m zIA4lQSiQEQ$rR*-cPPN`r)&Hp_gmfKj>RSGEF@yTUpm3A?t5|rLm}NRu0fDk)Kj~L z%Syf3#Yp4z?R&k^4~gs!p_ zt41fpnH^1n>R0I^ly1}{AJ2a>zde228cCS&a1F+~xk5ib)JMM1}pQAW;xjJv~eaoAR=WlOz`go396q@|yn|!;RZwxwBGl|-v=Uf^h z7+W3R2epMLT5dl`*#4a zqUZ5BZl~p~)OalT)w7;+TyyhkUdH?5&WrYuPnvSF!~DPIg=_<^q5gr*xzpJioyT~( z^;LmC&S39l(*sVZes!p|-Oy|gBpYWALxR3Q?qlh0Uam&mJl(#q`Sko)?D4SXui)0L zMDp@@U@*wL`}!Q+vqIrMRgzj=8M6z=&+YB<>CE9i#`*G>1JBkuwVc4N>+`haWy$N- zw!8JC(R?!I>*;~A)I@f~=9rvKVcQOf5@ZshrNZ! z=@bP|ysZ5$qJOkodt4O4$lJ)zFf{AFUcDZ(FMQscJ_yV$HN@Bk!Qaz?R(wTKgXPo% zgD|46-nOPLcB!4;(bS`1+O?4lh7}wvFExlEoVbG>Da$g9eZh4UQNQ4X)ERB7#86+8 zWA}<6YT^}NKk{RSw?|hW;TU|CztE>H*k9{0!2hKX{E3@RQB&Ql6rc7T6FVw!*HjmT zpwZEt@{*O&&`-beMSyBs=G~TP2!g1Y2C~FT$2Y}0@ZG!WTl|9UZN<;edw$!u%J)us z&&LsGN&IMSwGyTEy1(Y1YZP(ht)VE%;KlH4Wy%yhTmOyp9J?GMg^uSYeK|rzdV}(@ z;|yr(yBj4QlPlQbcEe(mQ>t+{y|?!EB0uFsaMbUaFvuboE@%(+nK8D1lUwxy6*!d@ z`I%%le-_LB7R!TF54!f35PCK??T;s9kyBSgH?21F@j)#IU{m*SbT!JD$kYb?l=gB) zcn2Pwq%9ns#P#T>K0KwfJezM@&Qp(F653JiSoPOD?QCu%>crhgy}6O>*)*|-X;i+_ z$b%>u%Nn~ZCSw1gHdy8-!6bO1JLm2|f^%JGa|Qd)ibi`Xr8*lb<}_A!tSi=vvE-FZ zoP_`I^|_2wE3PkJ9{{3GW{Kf-GIESOjJyh1^U%04f435jby^?j&DwGO`M#I#21}1q zbv|jWjpG}&j`yyV@)`|10;ig@)Vz{P&n3lAv%B2xS+HVy%Kpaa{l)mr+FjS@l(Zw9 z`u)`0l=723|4m2cXL4pSzg7A78Q(h9{w!iQt;d#Yh?fUzB0)wNBn>Vh&wzHPUTen) z$nA*2d76e|nQ|F#qySfw+j3>RWt)aHl2MxsGW@nrH4Ij%?p`Yb(cemTMM|)%L&>mL zj<}GPDPrIw^5iuTI0eSzH|;@_DIVr-NXEwA<=e)70uVSCKRcvRN6$Q5wi)}VJUZ<- z1R%Vf`5>!wGu!7ypOsIzJ<^h7qh;6N5aG{1EAv4aZS zOC33s(l3h^p1=+LsDET;HeKT*ai4RwD?JWN0mNLdOk$270(fP0+WEI>8u`qpJkU4R z2bU|1X>A64ojZFJI!{MH%Z`+x&&}JaqbI6-gcnI=$h|y#Kd39`$X^aHt#}{3CN8H@ z-f|N=K6e|7dU(}gTO*pSIY_KLdHU z**4%P8d$riZXMd`1Z(#hOTBeQPmpGYh3DVj5nXa_>dSl@sja5?G(#{VudJ<9vNs_8 zb*n)i>91}w;`Yk{%U}>*U7VsSH^MP~bjFSN-OblR;lI5O>7`^SV+41RPyGowOtk|L z79~TWKD2rh7_Q1&$QrCEW9Rz7eHl-S&)eppyXY-9E9BDCbtmzoclr(fljAs)%9%S@ zuk*x`k3C+%PU1~GxkDi*KIFX)AvIHMG7)_f?|0rL#$Y{s_E-!=Q?_7kz@gyELqJjI zC6&eQu4z6tz2FJ6Hly=O9v6dj}ruL5Yy%Vd;JM@5%n#~jp`*1VcBj&Saxl#@Ko z*eu`?Z5wT%r?>B9&~@eX5sU74sIhYl%lw8jo4j~KQCnjU6Nc~D5-THFpDUP^w+$Er z{Y^j6;HWjlJ71}7H%aPq6_ZZ{OpnbFu&?Tt|B{PhumDn~FrPW`D!b> zzeJh6HZgI(*0h!+L#B<~YKnWKZ=KFVtAe%8jT_=Q7}$*m_af#m3h;?{Cl<8xQaa5Lw73th7n%nTZYnfTNhxMyE+a% z?#ITcb$KpCP#S5^>>ylG|564X4k?y}n9VOC#%N8sNyJFikGqoOjw@)>o8qI>Mk~NK z2Wb);52%q>8p(F+G_g+fpGaMFlJ^WT%m85BYD2}#_bTBdwY}UL-A)4-C=I%+11c^j zhPWQP)$Xds>ybv~!JPw>1rR6d0ddL7o%Wo2{RcA++tFxUSwJW_56HEGD?{#*s5s+O z$ScedYH`vw>OM#+8HVz)#2V> zK{U;5xS1)lzhZtR4@OJ?6LmNlh&Ribi?`iV+Db1utv>{t5iwI zN>W~Y4%y>7oA|_KUv)y%m>YTUhO2E-3N_RIOeoAER&ax#sD;x1r>z(Uqr7aI1}y}n zx+LKnf_-pw>6l|u+r0Fz2G-<=Z+ydF9jMap<**0{8mfc975M=D{AkLn-nVe>LxQ+i z4pa+D!m|AOzB+L)l}S1HS+7o8TAk;3vhEDp7AD2yM?4K&7LY-lxN+c>6T)5M%qKD- zF$Kg0%yi|f2s*!PT>?GE?;l9@y%He2mmX$id6s{XecFG#g^iKwl42`o8fuMDhReM* zAa0K;f{w53T}D-9%8)sYTbAD<@}i-mDHfg_;5+*eKdXt5!h6%&9HMI+uZd} zqB}_(%Ungefl4oFO+jx)1xsu^%?|*E5jQpXl;guNZ%<-)4!-YYZa{ET&X_SOVNZG} zm4qDN%_#?7tWaX<)la7Do4M+1<#;&@Y(|Ms?IbmFQv9Xr4G6~CyTi@VvpS5t%_32J-E zg@7JA_~th!Ek(7Yj5%oI@`mPp@aJQbO3>nGJHj68ms8xA_ADhxv8*}zk12uxjxqZQ z9t+N@{(vD3z)unhZtEXjXlxngZWuN=*&q_I_4i?mn4(X-v?{}FMBUOwyw|5OV`Apg zri@o@OflGt zQ1%WhZgi6%omS-EWWSYN{UFj$#SniL@Z0q|g{uDCPwOKX-l83SD8$z5ZS~;J%gw4; zP8l=Q7SBs!lR4&tyMm!4o{bHc>y?vDHqb#NIh&pBEX3k>{@mC)@%5XMWKqJx25Zpu zrmlj4D9b$E+@__pBo=irSLE>AFJCpbPs3*k4|a3~l(VRI=jKpGZlm;4ZNr8(`$_`` ziad}*${$#wo|Y?Pb(_~4eVddzL8>{h8FLzDRO;I-F~OWj(t~W4KNkm+V=9R(y4pQo ze(^?0PrOP`S*@8POHss`G(kL;c-7joo&211DO2Nc;zP|3OLHL$n$nO3qHu@NV+g%voBU+0Pb zSSBJP9n9+`%(zK{V><2%BM_+IUDGmg!Hy*%zH{x4Ab1m6wj? z&AZ{PH8pZmVdbA1WeCdX)|~Ox03r_FNl(p-q z-JVQvKamM_?YgmcE(|i2IEI$s7Y=AN`<}9x*(yxE(YN)sD_7=)r^>l|c=wT;YppEa zi*jx}EC+HQ$2^_TL7*Fk&SEVR^v@N!k^=tsBEsL+ge)5$6r;&KPG){x@-J=H3ccG%G4rv=@=xSoPCC+3Qg$P9 zxdg_^-jjvKNpH)uu76FLjH>4Wqq|StUTWuXREP=JkMny2{tA9BK#6RXEUO$2du=EJ zeSb{s&X<*Z>8dl%Drm_=Pw4#N_qx}I88&@W9D}mNgUxHpkA)}U z7!~J4_@fP_gLx$TKiE4=eBNn~76R)Qs+G>7y#_qn5l7Q@l{MA#hjFhQ_Oo0h=wCvH zuX*Et*f(sPDDq`&08Vy>h&ygZ%(rJQgbdOQR6NwQciOFHu$=IJ&@n-w3M+y8iJwtp zD!r$l`N4=8tnuQrgOMwbmBpIrLEAQ4|1*xG%gn`P*%D9i=?S@IvD#XvNIrFMHU4(@X^ z)7rqR5s-m`_F4L=wj5Tqp{MpMX)VDc`}bq`_mdHHk82klsi+q#hS(}{3v`Ur$qN!> zp>WQO-Yi_sj|_2BXIja9+B2FGCOm|rI=xq^$FkJ$TyD}xaXNFo7(s&unF6Ky0l@#*UCtL^#~(O4|Sh%TKk)P!+`JoPpxZ&qxlU4@G@$F zqF^Z5ZDv8pxSMcM%D!dkxM@umaYY`Rd(fw!q8@CPl62EUj9mOagj^bM;QO7*Mw^^t z7Je?v5FBN2GN9MEF9%!`*+Xb$4T@FVN#E*4u2EXC0@9PdHtzRsX1vCljT^bEStaLE z{4o*Dn_6m0to@ErOr1FFA*ainz{k8-Ww2udc|p@-{|%o;2Zm!2a`w6;7NE9t7;EBa z(By494?-+o<(w{*ZCAo%2G&m#d0+7Gd+3JfD-`D$4|N52xZ%n)O*JY72 zMB5FgGW9u};;{O}RhVLuk=r|#q=+}EW%>%_QYo~@mL5-yI*7h{nwz(0kN7^tpT~35 zw7#?IHhVEQQ2$a+Pm-G=YyMW>$85_2aE@qfYPIsa0miNP;tLz>yi2nh5zMJ-On;3Hm(F&{?r+ zo>Rni{4bj5^HofJ7Kl#(sdVYn23hdM!9KU?7X!;rD7 z^p2Qp3RqCW3jq=wuLrN#KfEo^AV5#ERKaMx+<47C&~3t+HqCI428H{m$MUv zr30sQ?SYNM->#9P{Pj2y9;>xtM>u%}TdU;;0n`e!6?lvpK-+44aju$8kl;ZL*#BPW zg%UNC$&BXaXwcKe#N<^7L6bR9cQyhxGOA$}8QNg1wO3%7?n6;YKj1&Td2!1a+AiNe#FTp9&8gU$B*LF1%>-@PROe>UywG}&n^m|{oWFY6= zk7`~4Yp@;T8lv}pPw=*@*5_6tjQLs{Cs|J!tqI#s6jDMS#97fEip!o?h9aQlh^ir@ zHdGarsdJ%Ct}`c$@?ntuP_1urV&qn<+SgoU&oP71sfmrBTF$ShFY}#vM>;N&Nu8p(=St>l9S9MiPyM}TE*P4r(_XsX)RO9Oq0-#L-aU zz;F149Erk4k<7u#W6I}!UrI@(H;$yP&J&}?GF$h>F4Y&DW|!Lh!L6e}pngai}nnL1MbZQ*c!4c)Ih|fp{fBf6w4XRBQ*d>BH(z)_x7z zb09yAG)NI=jHIz(3oX@l3B~-P>_NQ+whdbHG2`$;vE+JpTwz!KRkf>gik;+mKYnuq zH211IZ!`S5I2(`DiY$_U zF;8cVP0S@&?mjTIiBc5oz*ycqvl;$fb{dboa=E(rU4rG$6cg;seD^Rm93FpQolG5RYM5$8P+c`8ug2~b!Ry=5kKoS5S zRMP?Vf|wa-bwlzt7Fw?5?zSw%<#_4D2ecf z4R^9x-dwq60%_xVDTX+bEbEw|!l?YK?gF)Oqz}CsF`r~0e0hwgHA`&E)mrqgw+^K# zqx#Mq`tlEH<-t;OXGdlwmVwiUcVGn&0$WC74tl+YgOqfQwP?uSzbhgfgZ@*7p{?i~ ztd_7zZ{}FyPdN;5R(!La7Y-e#rV5R3uuXS`rjjsU%{nKKv{P?I5TIp^4HL~jXi9rT z0yN+=QT5UjhX|YkeJ);IUeND2{6L4}r#Btp<$xHEjrtj&cx3x@FZN z0lagwR|%;m-%_-$OcnI^!Oh16=HdlUI}V`RO{!iEGyY1k&3M3(LXOG#EB{X&JPZ?k zD&LLvx`*yc?c3s|%f9reoCIrx&1gwSd6?TcpQuMczqbVYbWZm)H};>)%8qP?BAb%d zf4!SWLZ$#>xr3JPbor!T;*g9~1sAG2{XwKW)1~?ue3F`oxK*8;&2BQ98qL?TarN4C zKRks*GF_pERY244#>9EWL$+)f2v9UDLC{$EqUujgRva(3`_(7^HM^(NeMnsgl@}x? zc&18q3vOD;lj;{f>=b#>Kj?Gp7%DXf>=wWJ#olXukfWvIXOIy=xQ)J`YN&IxLP<%| z%{o_H~`#qqH{M`{9sprl%6~i+eT!5??~| z=_&C_(l1O5Ou8U36Vob?BipcLMABPs>E^na=54S|I{*eaxJGa0Fa@}E0>Li%Ey*wV zY{G0PXI|gmW>(Gjl()kwve$kQ+`(P>-79^#f~82C+vt&_uFk{8FY_Gg;`30V(yIx2 z5jr5fl9YZ4w#Z`ay-~sEB)A4uzZ|ws!pWasIMSNd8C3y}jt2W2P8il&UZbcxAhI#~ zhb1@(&nIO?X|es;Q!Q}@#E9SWqy(v)gc|PtgvJ75MFj4QMgX`1TqG zk{hm)6FuRUxx(ySg_`$uopxUkyrR60Ej7auOHv}ncjfqclB2Sy=*_UYv$t-0qq_P^ z0$Ck#gNX&6X~v}O*Lbc4-NccvDU*9;R3--`9(jE>MP7$Z$8xg>)^6AT2rhBmrF(8d=Td$R&(lE&VBe)T z2Xt%<2g=^N4V*pVMBJS=-T!KePo`+U(huFWpTU&MNv}3{nX$X?(?Qe*&#CVh4gMG? z{o!-fP``sT?&SQ)Q?>&6)FG8}baH zr@r+4AhYW2cU;NGdyJrrQ*euZRS|UZ7V#BHrX9IiculaQkB$g-+NmVbqn_rzJ|t61 z*jT33+R+!!Lyf-KN9(a4vlSP07*T`G3GmO-6H>57vVxlH5F#na841f0Va=ZQ0b9Mi+$n&ou z&QU=Jk$Jny5f4`kV;Qh1$J5c48~vDV$KCiHdV9%URB4C=n0 z7aUYcC#%z4<$K#<1)}9{BdcPgXJ&B^3TT&ZvzxEfB<%JvZJDwV^org1r`Xj~dR_Hg z%^%_yQk*al5DU`=n+$(@-^WUEHvx_~rgqJYKOi6f&yU4krtr3FXMe;6Q|SOciL zKRlyO)l3ifRv*~-*Ao$<{;|(g-^qLl(QXH`duM#MwGLRH$=lmCK%ZXE3^?QEBx|lI zUlN_hM1_#dR8Hp<~ zRDH28+zBx~aeCkPm#{pn(2)5+mcC@kK*B2CSQuhDrf9`bNg z>7FTOsIf&ute>h3K!gk(cY0=_3Z<#9Kjv{CmfNZ=6xOr;JP_|1J0CF4F~Nv+8iBRr znSiKpEpR^boE+9Q!50ee^X+IA8ot8GJ9xe%N#T}+I5$FhZA&nonoHas#ek53v49Pgkz_bI6VP*V8h&{gAU5n<$oEK* zw0Z$}#M^%oecSJ_4|qYqq^$_oz%Lh(##mweh}Pfluw>O3#$4-u*ixwOat2q+n7pMM z_w9wA_k0LmGcEhcMV61F%tUJ13T7zUNB%k zYc$tSwT(szd;(9%CcqcWCJtRmm{vW0{Btf3W>Zo8Wk@~~Ib<*1?zVSXW2ThSr6X7Y zfOWW!V-MEu}4Hhs0SQBZ&HlAwa*F!cbmC%$r!9nRy>lhaY(Zt zg?Hv!*A1V3&bO^6YbVs0TL`~}33PcdC(n3}ctJnxeAcN- zPsu|qjAe{@MnSj$9o9?c^}DouHID!}T)Nb@1Qp`x#*WxFpZ=pW;}@>I+ESC=>9Gk> z9?#TlDKNuOs?{vXZp)}>LLToJA}1~J7_yfv80nCzX+x65_TU?Ex*i;R(=T>bi3zu; z=ja?F^iwykb-NFyw1c3Yd->aP6Tm^%NfWPAMqTkh`}mX9o?n62I}!=&P7E{5sc0hD zX848l#x=;nF4S%6N@QZOQu~HjLqvWvj8(7qrkvTqgInyh)DXzmNsL{Vh(2R@k z!PV?|T3i=;WE#Povf9%8He_j~Jogh|z?jcna&^7mKLdn@*Ibw14U5wfnfT&P>1nVf}FR@RBOVboI-_GJoOK$hns5_Zq`J6Fx`Crx<;${>W zMm+IpESE(D3_84Xjj3;_0j|GGDw!O%gA|)z%tCdx7?;HZ?Sl$BiAc|B%BL zx)vVRHu_xfA$?a=gBm|rz!Y$9dh%6c#@C;Gew>&xTnYQj)}S$!&Leao_!%E+er3tbN!2~6ESr!2nGU%=QBd`D^2?$-{y5H zPFQj;v>_ltl`WQ+;#0Jar6gCQ&emHSUj3jBa#5&a1URFqIw6yAQ6(1t}AV&_&UjGs}- zm4P13H8TQ8sGHH6Fk?G17M14S^ZW7?Z5utVhS$4j_ymxlkWlHqP)y3M%<7K5I2H=z z@?Ujr>##jSvoK7vj1nL-`>a9Qhb^XFpK^`XK^K1KpCMvH>QGJQM^6p?_ksHgP|MmK zHTD}6qwi|q^Rf-QA_}+r?F2Mvd6_4(Pxyx@oLb(2@dEA{_iCj+S3n(Ws>w>!PnJ$! zb)8=cL}Ujd-e5Dg^Sh+Z6==_75a?GVny&=iEfTWDE+-G|)Tyld0SH7FLmQ2Tr6st& zVMYp6l2i6Eh7mr8_;LD_z{Hnd=7TsK8 znYbMt!JBK)e@S>7J74v=1%n0D0y7^8PxM`&{{0oHZaDir`{Y3U3^VG!HCSX;@fuOz zc)ix1b|s&}RM+%1O0LS@s$+jmnv?`r5Ch+0n!mRfz;OqJ_=Y!W%~y(7tgLHyV}+?x zikz1W<5kJptaBG*7qtReYZd*&gL`P{yl4boJ^V$;YHZu#!k^`IZm*8~N8`c);e7?K~Xu#!&SrR~*yb zGEno%7icUmK-5`yasv9whC8A(CakfzWOM_HB|RrdcNM%A!C&kB6Y163gBrS;OGji3O#zQZGz(@a09ABpp@VMDLl zt*H*wyqV)a6@j3wgbvi&ik?|@Wu0NhDb4x7+fg6G2g46fUieTy7C2n?D)B(n4c_a` zdLG2VHSmcSQcC?`FV{_plLF}6AEhsop*(Zc2|<}H3smZVgbS-<3S$nPKl}`Cu=(-KQbD9f6{+(&2J%0R{uQ<2#k>li|v1l|IetB(p>~WicVF zflmBKr4jDyn|;{@#}V2s6OH7(Mx$D)4JL|(J`iw&7Ymyk0S9TJJ*qM>+H(4*d4Q>* z^QtP-I@Myr@iju^%qs9Yu%Wl)>SJ`&h36`tPL>VCOucM2#jGlr0F?JFKt0;ZHZr5t z-&#`i*ZUo@J}eF@jGLm_Tmhn@Sh7-?UFq!zAQS&wx!zZD&zjeum$|3#R`lHJRa=t4 zErDF_J9_1CvCxhlyfo@**PAQ*CK#Fm>q`%{%xLnIPF;#wPIB|ML?f^*%C5P?)Ea0- zgJw8dU}KICWU9inq*6C^)HiVwseHkeQT6IwU*d?%FLoXYhk`zlxSG*|;Rq6@c2*}d zGveEv6BqjJ!I=#%PaWnIf6*3Rf+$P1v*_Yz6jm>=0_GOqw(SK%+{RYZY3lX&5ULIN z_zkBYb)dr8)6&SM33gy_#|6WzKGd5DswwZhn1V$r=&>^RaxLU+Hw8cVV|%f+UBOBD%$8l2jc zU$L8gn0Erc{jqB2BypEK@P0_iu$d{Nx55qz(6bFnlOF{}sYKF3BcfbdYx?u}+(;%v5OsRIBUhS=lB78iI1v3GgkxyGTU4M6la)qd7 zoe}D<)s&lOUrP<^zs)1dxKVieyhh$?ZYM^xRlULfd}~P5x;-rUAY_EY9XZU7H#`U- zN897h17i`|yXv*ViK#0YRkfP31m~<+Rl9AGyZ+37V)(5J}<6N{WINyGv57m zEM^>pca7E4XlzA*F@)Nb@CC&vv+<88UxY32dtnZDaM zICl;D%(F)adp>j9Tgj;UsClEo1y0q}O16@8mp)6Lzm|s3oDn_zOaN^Xc!;r(0!Xb; z+%p;aK*RP9uBh5}0Vl?N&pl(4F*1U;7$qb!2mJ^Sp2_SXiD+&!w^LG{!`pe6`aFt~ zEixW_k?jEyQ<1L`&Jvh=xsS^cDx+s4v-;097Y>cyu)h0^9dFyhJ8>5)Az!>m;~Kp- z_O((6m!u1tT!qO!Y9lyvTKCN&(^i(m!aBJ(sWHce!Y)UmV{_V$Z{EyAS{GKcI@q?* z(hv;^I^gb2+`?f~MuqU(thE2lv`b^E`@5FY5p{PDxr7ogH+F=i{odOR-OfFr>^<3Z z`_M>LwP>1h*kYc~NoVFc>nH54xLsk@SxL(}?=bYlY=mEXtAB?1R3N~b@SI3E z^3xE1hM?cf~$~#-TR~g)UVEX0 zbB%_>y|)DsrC!S%SS>yiWoL8x2?ey;4j-Ww?X&r(UEjV~eYHXnB>S%~XzOnGi5N|= zcw5oJ+HK#U!jJcyAZ=_fp6JOFZTDQOBHkBe=uP1h#T8fY)|z{wPT@1|^JR^Mj)ce9 zPMW8nulz?j5to_raO!W#(z?6*)T>sFbUJS{r<}LzWb4Fil_u85IToZ|!feDu&ADDR zIBo_+Ie%hjPG8%XdTN~@l&|x)c!nR@`u>(>ebB@0kK$&U8<#QO=6&GsE5>l$0i7%i zh|KzJ(-=5Q_5t_(UEqoRcgz0{lIm#DmWvBe;=LJ*`wrc231IOvB*R;lJr!9rT`UNg zV^BDEwa>CbkFfaOs3-~z9Q+AX*D^mo-LdmNAJe z>hrgXcp6hldV?TuYC^i5IR^wFL+B74?!5&&DRWFS>89Csvtj6sZu#MuA~q%npyIJC zU{j6Vp#J>V{+CPE8Ex(uBWcJ6{}hzwHJ5TYucoM`MZ`I-aVzePM(F!lgQ?X@9BT!X~ofFsIyQ~*BtYeO@ z=&7*pH)Ed-$cR*BU^-!Il_O0(InFjzR1LPt=}bK<6DZ{iVer%d&d~tWoOH@6l_888 z5hNZ9Qo}H8o7f@SFqX4A+t-!fHW2nP=H6NLtZULZQ8Uy7&9xp*6Ugb7_jk=p#&SK&Ur1-S>UV`{kJaUZo7R9-0}K0763#!*i#K~PA|99VP4(J< z__EY<8j`;UD4U!6$MhQzkzcm0)xH4bsl*aBa60#-?GtU-B%(gK=tHwl7)`1{i|^-Y z@;!dhRlV{e4z6zW>YT3c|IYXvQHjG-VlC(_s|coSi!lcJdG>@YB+!6RbjI%%z*8RC zY_}_-Q_j#c%OOSAC&YsdYr*r|z)ogFAxV+nFJB_Gt`z+V2uq$PG4C{xn;u!3{-nw4Mou zg-bE=51F>QJlk4H%U_qj;guP*bg*sL$`W&fbOzE44dIsKH;!}NqW5r<@IM_7LaD-&4>ZWXCJ3yU+Lu(*8K*X zODmJ2?UG!78q*s=4%_O!OHm~b*V;qJI%%@duJ;67Gva4c>i+spl+4XPh0q&@6$QgZ zYUHdqEgFr=^kzSw3>FT~-psya88#>!oz+&3kVBT~86 zJV_@u=@(zP@EZZ47s;|8-VmP!*wQkE0o@dp1H8G{fr~4^b9nb^ySeSgg6E9>i|U4n zVjp%lv(Mhct%^U;z8N*>w^Jr-r+}j{?A!7vk}im~hKr+;^r>?81H@9Mzn;yqF$yVk zpWcath|DQob3!&m+%;B$9tcI^0BJmB)%HmqNh!3vi=STFbsHsSdqjTLyI=1e0xp`Z ztFO6jfXBKmMh~>N7GCwh7Cd7a04-g7i(&@*BVu{`Vyu{H!*E~hm7a8rhkH`G7Yq_a zW*2cojP9APtyK5rOe`wp_OC}C=2p40q*I3259cm$ zlO{iC_g%a$@%$`S7J^4VubB1kCqzf%m5zPoqTC{wDR!^7t#9*-fAwABts`FoebckO z;D;YUj(FiBPzBM-ypzfD4W~>)tnmW@Ubf=00|tIC7>eA|@TJ_dxta2YQ;;I1gLYfw z8}+IIgDTymFMUy(;(B5;85YIs>a?%5t9bxqE!2iC8;nl`SYj?XCkxWt(`v6Eta!Y3t09&s5#D_R76Z?drz9lH* zsPXjM2tAxBv67*Cf=gkFvC=Erx6*H!-la$y;LDDjy~)T42$WcE@+_h%nM<>q>$ojH zo!y%QGp&yYd{)q3mwUo~nq3^U%U!eThSs^KXJW3U0@yqfKUO0fe;Kr-=0!eJq;zDn zM7B0Ontb2?Ty7)6A)>=-i@YT`VRY>8wLiviF4U`nvQ1!)C;v?T#MuR8<=d$|-sS2z z5G%Y39P~w{FVCL0?O*+Dm^JQf+28Hk09wV_A!4(osKul(3IQ))eA|476Om8WclfTzbhS1~E}E)fSqiX96xloDPD6*fNy8pYGK|Cfq1}5O2Tedv#(KxlD%+xerfV z>`=JG^r+fb!+C!=MWC>50|>%Lux!t8KF@7+Y=laPUA;-FucmI!EbnHfxYZwgrTj*Q z!|F$MV#w>@n1bINgu!?+VYRO}1YV`&jynnz9p2TJs=Q=oObKP+)Xz#S<*pvu3OCYG zqavi*GB$eikQf7+3WZRs1 zpX_$>uM#}yT-_-QYIk285R|?NQYomFMua~nC4P?+GtC07_=f+HE&1$Ml8-XKCwmZ? zm3+nJpAAKS#>UdU*?qlzq%y%$SZNq=wC)e}eQYg8f1yC7W$i z9h;gu38DXL_ zLo|u7-V3d8ronQ79!7a^v}NL;IKDArZG;?+NJyxGn^i{f{Qaat-m}JU05f6rsN9)( zUB#eORs;SajA%|o4C_VC?t=ozfdq=5ixBuCNNRvGS%V?Y`*EDHWZpK8I?O{fU zvup1j%}&TuIAvV%t?}r@-`eGB7k!9Zn|1x6Jee^$lM+?;TCH*cjQBDZpMvdCvP&h2 z-3re_N;tG-c$B?XG(+_b=e8zuXcxrWyYD2%;p6AuN(oCwL)gU)Lvng~)jq2Qq>iEC z0(EOwrflQ9@?|INLz*f-X{@A;De3a!yf+5HjcEUXtQvgoo}VFrsS&md;utwiXZ9FTTjh z5On{|`6BcCkHz1ASRD1}r$Ik;arFK;jTXr+_1t?@KW8r(P_^Wn<1|T!|V`ol+N8Bneg(WFO-e(A8h|9qV3ZF4%L2V6-DMA$EMJS89 zW)V{+Atr@GXJWmve$`U2QE`Bi4L`^<2O7OeLsIGN z30~8Fwuv65=KFc?W_;$6nyVwM6$#g>7Lgq5O1mAB=r}g^1x?}wQ`B#_!1F|33h0 zK$O1?unmbec%0Tuox$W3)+j9;cw}*Rz*@uH8dmF`=FNLN`-0+LbkO%)J-lLW66SD% z_6}utX}!ugrb&epuSPm>v5_8?xMNz9>4+I)Evav@q)-ZoyW(WZ_ei4!S0{=G)Oa5v zDtMG1c94R~O7LkzvzQY@#P^->|JxqtEcIl{`tlOrbcZlGc-+|0}7KjRmBh^Atq7? z47m-iA>k8f>#)j55TO+P#TB;7br|m%+79a+WM-5yg_a#jQK7BNH3MmarIcpqTB^zs zGAz^k?D(6&YC8rQuC5s3fUavMT5MK^?Uon<^=t-8;X}YCm`@w7wms9vVy)$&A23nj ztm3Lm48Yu4uG$S=L8Fu?&O_o+>**x$rr&suRL^WCtfLV!$}mwXbk?#+??EIn1{fJi ziL$DVV2NTB+6l&=Mp1ZCM(_73kGbJhqSW_xo6opMkpI31k(D2n@BDRZ#$#ty;&GLk zh$=I}3PhH-&60e@66x#5PC;57E39(@H|JXuhQKgHh9MG%NbiHR&h8}$FgC;9R->#q zF}TW%H69sHP~5{)@YE`@iSqBVd8EC|8*3qDas1kQu=j&;6MAy{$CDEhZr^iEpOWk# zkyzIY>f=+~{X0~_XCYCkw#kB5Jd?ymc{jj|B2{IGX~ZBi?UzzhDUkq~<|+XM)@r6G zx*@V1B5i;^C4A?pw4$~eYa*2?&cQMet%|6oMunD5jHtKnVrCN_g~-%dhy&Zy;OmJL zi1YOqPX1$qK}i!Sm7`mwnR40$YnMyR9mck8HiiI?Hr6Wj32gl&2NWXcC5&fwoH=U%xKQvT=cfkZF=#Kj4gJ zyKOmIid*lxhoBWoi>@a`Px1qY$48`;2td1Sv9+|t?Yo}n2iY)`9(n#H15jEPrV&Dj zQrsPUz!;l*bZEBgja*xd()T1LV)S{V7m~mj6s07MwuXTruLChgT+_hSN;0Yxu|{*b zX-P^k*8;IR0$of@lwx5tTOEK9wS_Hq^@+lp^#|+Ac>3ePHN3Z8s2yC?e#L z#3@Nj-O5^xsV&AyUC&HpvzQvi3XKPxk?~V9L-IUU`tfX0_GrDUAF)I4VuXvgHFvMR z!Gwh8+Zo^TA6;dpK?H5Nm>w}X?AScKpWP@G#oJt!B9l@(%Yq&PsM@_|L*Yn6n z`inJNC55=7g`w?QXetc5Nmm9!QJU@o4TaLVF;o5?nKx=Y=UovpYh;qp{K^KR$08g% z#+nhQPe3L}?$NCk^Z-h1Wm1R?zLgfi3X;-T=WrAGoUZLiNi+>r)8zMAHrp+J=t;)O zU>}SBvRuV%->wx@b%nK7XpY&tYH_&4Wh%7>Y9se0L=i(yr&B6xMg@OB(S^hi1Pm|= zh(5!02JgjEK87T^t{ia84i-$8b7ByEK{uOFSwk2Gu{DXpJW|%7V;UO$lME681SZZBR3aGZKvyNu zN#MaIDY^v8C|0fKdTnTGOVGl4yXph2kKA7kOgqoPyr!z9Pm4;T*dM)}3RgU59J1Jk zaoi;3a~5n!DeSTN3`rF>mLBo?%+vlFII2KTX^g~ol>zo(q}?I4Dj<{}&haULd=`Nju);|5!Q(~O(G}8 zbb4fI>BsE|(vSc+VhHi_iEcN056%Ekg`<|}t1lpNQ5;A*>dA!Qdxo|X2tX^Q%Q+{fCz-h<5w{QGKQ{C|LkP_03p8o0 zJ%CVw>kL(dB+N5T_ZX{L%w`y?Y1eC71`^_Wd31jlw$6MZP>S-J|s51$OhC^%Vf1;zEmuxC)Bp4L(xUCH1cR{-pnPl zNZCiCvabPISM)4mrXvHIK5%#P~IO zlBftOWeb%=Tn~KkGYcO5%971p(I&WgWcf`OoP5{&s8dhqdSYGUY(+hv({DD?lOrXX z`HU2USW$b?cwih#Dd|4g_sk{@Rc2E4y%#HzZ0j*>w=9m2h+W5YHWg=GC7YbcE<}O8 zZChrusdS=Lux@*l(jw~2if8W!AkhyYLjsXxDvZwFT`^)c%o<0#POQ7gwoRlI5kWy5BEAj8IH0^^vY3u^Cu?0MSj6nplsnid(T#XN2#goYEF|1-_YAYJk^ZpRIl_OCRAZBH<(<~~( ztZ{5xFAdrH!1mFG+8QQPM^hWL$#yhCcaqOZiTm%*_|zv}jtzEJNnAAO9F1jC)y8fO%n*3II9*gmv3N z3}_=+g1FksGp{BS`JJl?G2mljSQ$R^mo@KvLg8Bl*+%g3<0Sw0|Nd~($gS@VeCUS< znj?9(LZel=xGbB0^gYQ{44aLJQWMft%WA5+8rA29gdcjLduvS`B9$^?jOYV40z@>4 zE+)1^WKfzAz~yK@r5$`^oMvV#rW4q<1MBTTI|RC`j`|8FjisJfn5wi&O?=@qPw|g_ z>J>te=TS8Z-^2a8OMdSESn_LMc#7Zmqn~EF3=&9@7u?7Q2Nf7;bXCaXvCO?PT1R$K z4x&miS>@t#=^&|eaZ<=SkV4TNC(2IeRAA}SlVhY6lkZPC!}5Bg#-LI9g*;v_B9k+6 z3M9>~_Qi#ndYiJyG!6n^Mx`0FB}^Bz(;BJ?cD|%<8hqGdX$jpHKdkY|(hkt}3O8L~ zn+eu6fCMFb@#<(SnP4QtjE=-l=y+m6LbVa)@F?XUIn@c88QYWVxNgg^y%Mi1*mW2z z`j41Mx}>1Hs5}))uV#eDNk+4Ud+^0|$gToMG zp1&GWps2d#4Uj_Oi$6YPd&hF~Wy8Pp?@f8}I~>};gSP`e|5sW*^OGHK{*9;j&>wG^ z9CVn<;S*9b*lw9D7tCfeHtRKQ*As_8J)2TbCj>;pFquqf+ZL-0&Kf!Yu0vUitsHez zQ&$zr7@To=GfebBI?5@n@OdLoF%hyYNgo5&8bXRhrSTy!M6q|TCJozeK$EDgM2u%| z!_WU0mhM7sK|NEYo9X|jBL?U;nzw&ebMIFyzvDk|nP1DIR@BZaBX0`UTKeqqSBX6+d@GZO=ke8K}4Dbe^ulZy$XyDW?gt1^n| z)Y9bMHk(##P}Z$yyY)1UrJ7joesID+_{om|ihu48HGJQXG#uX2_yNB9iJqVO@hx}X zUGh_Z^JDzMANw>}whk)h+K~iu8b-}VNi9ZmLsVXX$@PUiH_O~$@7%SLwICMgR`0YD zNg}smoETF+JH3T%CL=2=gD;Ha zpz%h_?+%|=oP47R2|s=33eY1BFqXwX$tKd)3ntfY(7xAWe223cx7~xHL=Boj(v&xi zxKpx@#ixAZ#p6hHB#D&G2Fa5yr?gV3rP#hh%Ehd_c_8-PDMhvcJc%K})uv}&S8P&; z8WL&<^a}iXP1AIw)Qp=^Nt|U&__Q_c7PDY2{xAz&-XF5}P>eWY(&(Z<9`GijJC7WknIocm1)+c%9b4hktv;)2~>5;tyZ)&g;j#_03#3#SRHat1gRORIeXaK9*WRLBJjh1)8FodaB%2|S`;_PO-BqMoh=#MgfM;&UWuvHfGEk z^nP@%NZ1$uow3 z^S_+)Xa21V?tcOP$)B;*2Z=B=7$<^A-zTC!%8TlPZhb&CnP96*?xRv9--9~kjasu> z&8eD3dY)gLVm8xJ#qUGR5NG1T2WllGrMD8iYNfUFn24wSK%+z(Wg*@TkCYO@C%R5? z|LzIZMDaWR?dCVU-ua2cHWUr$!=ME1|cwMtTx`y4X zaP1mbDZxO42+@-F6jQTUD1=$ym9oldr1BL7vQ{J$A*7MkXU2^wUw_6Zi1r85IALg+mG`4!dm9g|FJCD4Ud?CKjks$R^IRryZwu}is_ zCq7)GjwGeM%wwE~<3gbo)RmQX4KcB~C%?Y^&HMdC9zSM>iscQ>`3I2)|K#}V^t6AY zBmGl;x1T8};5VWt{${i0@t=R|4_06I&7&NXh2q1%-SMfv-SPe}mwUQDrM`ACp8p1) z;`aW&-23}+{_nT$xc0ok)xY_@y7kR+ZI@>arA{!yq$w}NN$No=H?t^nc~q5?v!b+% z{EID39Q>ZpQHgeI%)awNk^dAc_OR1|lwdOEUM1ta$gmHk=uMUcz^`ipRkD?`z{6Ne zNtt1}|GuaUe!d`FyUA*HM5pa&xn9;aiILM-k5psJTlroImNE$-MU1OBdg@uW>lK$D zyvN1+Z*y?tDeBn_>2V|XV5BaqT`~Ph98Ux|yZc(=@+~dVHJO10dxKI2rm=>$p3@#2 z(JL#_g0(0kI)bqd5YtFCOd<34oyBCV8GsaXWCNp%XpV}E%Py{3i6udX$5b}*BksJ5 zR$i32Go2&Iv7ndOwjD%GT^S-^DvPchItGjpp_wrzXB}D!q*-rJGK~-ugZKCt8N8@p z`ymj5urZ1~dub(F+&D`{C0R-!_<_o3G$|M3;<&+#ZoR+Bk-|Uy_y2!7!thVqsJVf!uehrQ=qFH5bRs?h|T)W$+r}&AOHUji5PVrIXfvok74h`_5yir zZPtVB^eAIbj{=8l+1P{yR_dUPkoLIrmdz<<3T=pEzoAl3B5yn~Dm<2caYXy{3!KeQ z*zJw=U&8C4d?H_Lwj`rD0Ufq`8!;` zrMUarKihHsn;lO~NO;j%zU@yAdC$nql`$$W(KsY+*c@G_TCcI|Ga94CvO4YXO-U`4 zSWs&PQ6ltY47#dFz1V1wA~6V4D56MZ_7|tnOchktj@|r15M9FMknkzd7)7IH=M`p^ zWFQ*wKF|kgh}89g)CV@(j_I?3$~jV|?-tLlSQNl{AjBN4guNAhM>Nd+r;Wy>L{zzz zXs#dWZ1GNz8i4l$EkZf8xl7*UhUM(5mbX6VdFESw<41q~LFDp&Br4BW=0C$^F~!ZM zxXFa>?2N$&4sKjyx|q|q9e%Uo;N*nGa!KX16wMJrf-#!PXp9196gs65&(#Y0n0R>A z^5A04(D&5NvY1V1oTG0$YHOIggf@v!o z_;3kYGi?Nws3_>J$?Tb~o> zh=ao`(hv~Z^B(+^H-Um8h|=4Pkn8B|nesbweTD*Cj%>U<;>Rdk704pLJ)xW#2{i&W zWufC<=s%JQ^e)gFT`Tgx$Buznu)M2D?iJZH5+L2x zl5|#CBWW@bV=Ge11@`>k;1io6u@ONo3#XV^DbV*>yHWv-mcG$3!sU9)(R@PPSo&3q zZVXN%_S;CG@nY4ib0(xqDyoz)H7K4qkE_&mj-q1Dv_igD1^Uy#cDrSJae=X#=sn&C zthG36x%r)j_kY3ifBvO_eGsif@R6%+&t$d5+bn9-8xU(Q-pVa)$_mq_Z!+(f{&aLf5%%ilZLZ* z-zOd)P&>=%V$Qp7u325)VTh4*c*Oie&$DW`sMVU&>6D4taDINqG$mV#SKSq-a%38l5P zYmAu^c-1U1iv#T0J!U4~JR|;5(M$8GlyWD-DE1jrSCMc_WrjxZKEqilx3-lLlw!zr z6)DOOLuBP)?gqOeDQ8n=XtAU^Yt6SdutVcD0_IuuCasLQS zWO}sZz*&acbDj|^X<=_@PmJ9;P3xu6(4*h@aO;itA8e=Slw<3Kkz=v z2Od4R$8276e*TEtH?MOracoW&%o@Y-@gW-@Ia{wGY9`YKm4-NMm`*F+dhZd(%LOlA zTQIFBycq)5W^>N3HpITCo?6~H-;z>dk|K44W@>du;97(D;z?Msdh8;+`k zc2=|vF}pZ8y(==Jz?y8o68X;MpXKg@-^Qo^E?hl`eE+}EaQ#I?yGp$JO9Maq7q@hq z#LFLkmy?_4Y`esEJ7BfK%_^$KU`)!*m5?^YN=t=T=Yn{SxD~nXm~Gg1OM=w@M98Oi zRx2@%P?d~(g-TJNR;@C+kTZ^qiN_?~c?HcVwEW#yNv(!FJ}K=X61$BzW&|LCkBTl@ zhLdabPd!U#s?lew{8!MoLMtvE1jp~pX9K$|M2&SF4Y@g7k#-cQOOcq)7fhR4)-`KK zavD6@P2`Cx(II1}N!&npjaj5nEEeSnMIhK!o{EXUrbdp{ZSUnb_rEhkAiXnkc zqgYT_DGH5rIaFB~q(CgVbE+D8&)^f6Lt-5wje5PE+lP>H=f;@XP5Vx{l zYP&{T$DOkc!@5N+7939-h7f6#X0r(x3^%l5+ecQ}3Bf8^_?5GmgDJ-|$G5hg)q}(r z`@pB)UGe?TPMOt;gc(J$pdf@%HLs18Yjlp|>J5I^>7VB39{#7i`b!I5{iR=D+ly6Ntp|--1GENJ^}Al4CeIrF-gmI%Rg} z@z~saJS*5ATZN?-W41wh{Ofmc9qgT7MoIvcl9+VvmdM?;J;CFN2?@iM=r&S;WKwwm zN$|#)h&p#N6O|$BdPcQ4WP5p^nae#u3_I#>wu8_}Lwhmt(^)B+aZzK$^9RO=L1hee z=mT9V-d976%#~u{6qPMls>a8}Rvf;mDiMSAy{D-J`)`cGhRD^rx9P; zO1Pp*MqSe8uN@2uj2&54X=GffF z7xx?kdha@!3e8KU}Q`XxxcCujG zM=tN(<<`@;c>3j+QCd@J5jS35u8Ert+BF}3`8nF{niy&-1vgI*dHwBoIeYIthV2#4 zzw!#VpT5CtHeqHJl{UC^z-HU=*)M#Vp%+{IvrS7%iW+#(opDM+$H4v0vq^=`BM@MU z5nVyEsJMB1&PTSMvsK~?cURn;IbJa}&PJ##rV@=#VLai*PfS-9qs3qDsmUk#gHQhv zzIgHb_|?ll$dIN0JpJ4m-|_u#@xq56D$f(sQK|rxYQ8sTbMJSvr_X(+!%D;2X zp{UbG7)|Bc(3n#YlVVVo;o2=WH=e>9E1pLrgdWO=UAgmZ2%+=hlPoJqbgy6~PDa0c#ltaZ=K&TNVTv3?_>eM~w`^CohAp zq{oG&s3KWBH?VG7h=CgLArP`ncpL_tJEn4$2z1+y!Fx_V27Yjy|5?GiCm-su-+!0n z2aaZz!{@GZd)aXB-a}4LkEk2VN5AdEOlymChLeLse(%5hyZQN_{(Jn~-~Ky%>vw)L z&wTjXX%^R+)K0vs`bcFo^V%?JEVBe3eDE&se(-?1@7zb#4acX~n9QZeNHaeWgTS{u zXBR7G(Y$;Elc;q99o9xWjy9<>V7dY+vf!uFiw+VX|i5_H5QA#K#l3DvSj zS;?f9r!$^kc^-9F{9i-h3vXR=+Bj~VOoYarlE6q2>C~BWAv#GPc+p5%DjxA2r+STmVewyTb=i}WF}UJaqh<5 zxD~1KJIjXk9e*_P?ED){NGRh(p$&Kxgpmj#zb`3mPHRohGS;SMx;$cg`GAQQ9R|fZ zp`?zbHbQ~L(&&qoGAvOlRibV+^nIWU!j_n5XpF}0J`$9Ol-eMRc;hs6<0MncMvP=K zfG3Lm_I6-tE4ogsy(4M#NJ7c=mxyval89?dTTqiXsF=w1!}wr>e+;g&6Y(Qq@Az_?VzrN zW%B51L$Z#mt>?yK!o$sm$|^qc!cCltJaaNdYsI});MEV#xw>jG#?lT0!!R)P9h>uq ztk2Jh?G|SZ&P}+uyx@aJ=PXZ-Ilgg=g|%F}cEmH!+{PL(crm3!vA$Yy{b

&LwQ z?p-d=E}`9!+Dqn>n(1=EH-GdMX5aO3taDVxu(XMT#`18`T($#W`O;VU@)y61na@ex zmP(y6YbsXl6@wqBy`oQn`#$jQ5EwKpl)@sd2XvF^=t=5n%Ue@Ev>AAKZ^b)4@!7X7 zm@g`pHldI?fze~Yl~R=YVN_r(QA^wAG&Y7WV=|5lRw_|?f$bBRN-;lbsM^S8)e(kB z7b0!zsiy{A$$~C)+%&SW#92GX-sSs7$k{L&qbf2FwwMYsj(4qg8&c74jniotq)UcS z7W1&PJ}E*5m1`|2H^PcZ(JM=PaE<=yXX!Jsr_5Dx%aw&)=i>XWGhiAQd=Yr4S`fQ69_#M+!v1{vteXu{yx zhKN;AXBwf(4S$5~q$S%xBDHPXF>E`k~1ZnB!n7^ckxKXeRzPrunPnND!dpi)0R4?hIz>5S!k z2BGH@pZFX%Zr$YM`VH_N9X&%xwBE3}+VJ4)irIY1Q#Vhr#_=uR^L;eSBVPaXr}*M8 z|3f}_?Py6Rd?2E~@SU>WO2Cy0Ii?5#<+MhmK`6s}=e~>n1go?7*r0-FD2XC~HjtD74gAGL*G%PqK$bW%x?v zuNb%2atY(*?0@@y{P|mbJh6_1SN9CFXJo-FH&D9vN%3sw3zc^Gsl1Anw#;S=>Wdab zLOHp+<3^IBi4nF!-mA-oLfQ?Q1kp#fz1TxcHE6RlUMqe=DMW?I>1jUx(o=lPOSduq$`A0`7e38j{mXxo zU;E{s<%MgSqvx(uE63-)^s9t=!gEjEVtKH@2ahFD*Hg|{TaK1f@DXJzqUv*R7R6#d z7j|6;Y`THlHx6irkZWj$*B`D~;CcGRn>a0X-LgDAf#`9@(D}%lZ@$mF zUwMbgv_Uz?;jJ6Yk4`u~J>d4yoNFgX;3^(oZg_Nlh0>O)Y9PU4;#f46O2hf8Y5#ar5SNrcEv0Q!3;}PKwoFdGEmm>mkyfU-AAs?=m?#Vs-I|iMh>k zQqyBGrb1&l8X)uoL-Y)Y;p7BG6C+hqp|dd6M=uOU1NFl4-1CQgpTFQ|E?YkN{uQS) z$Me@LwvqruD+NAChU;9eRmE)iQ_}9e6r^k*g=SlVuM$uf&$tj!I?+rl{Seq}2R3WZ zvT^yd(}>9k1S|8E+)PY{aK>;m?myN{GW1(~v`T%XxB`oTr5@`VW8GjMZ%VmlGOFO& z)gWWaaG51qLpwWUb?qs7v(r}Wx*N)}UJO_Z%2C+L<=B}smdjBiqq5v#z0a`Re=mD3 z8j7(=oX&)ZROWk1JbFVhnSO(HB)n)H-}WbWOph|KQ??K(gDYn3MhQ2RQN*NKFOG1R zXH>q&7=!HP0#v+`&7&0F^U*MB5K8;GWUJF3(_Y$0nX_0^HNIEJ4ML^=(?Vv zZ3VkdYV;1$+Kg&pO~zM4WW8FECJo)Tl~%Ns)F_1JD2MNQ9=!8DP9<#e+LaM^jZOB^i^xO=r>Xgh)*xHv!ODD2^4_NIunp%8<_b+n27tCwRypkpY>n?HsqQ%xVlPdDnH$T9+imSVKXg4hf&m42u zD2^8m*XE978}46isM;-?I57AYk94-P3S3N}6S@+{VF&?RI}yYwOLB_oHOGqqzWvLA zU)=Qk;_HuC7|pfQi5P*Ra({GbsAild_&64wV`l8_4NEz)9S~)%s*EHg#`y%&y>B|L zXuE;+W?(X_uvIn|R2k<_yT!Q7^&JeYM5vfC{?gHK*I_WfM$&Pa*T&>?7n9VH=UTKU z2-9<9cIEj!GVdY~710{{$%6Hbr&-%tS_wd@#qU8-`Rvn9v`P6hrMoovyJ~7GYnW9PDQ)&1NFrQbFzJ^(_wtKOCpB{- z#|IVmg!{PNg4XCtzl`FOm3gh)D_FA zXle#6)b3Yac@ZB1jdM(#W7%j98^vbpx!m@2L%>uG1B%yQ`+&CdI9qY{;1S7H+&Der z#TzdX*AG#{mRVDA*{&G6juZ!KqnHJ73AzY_f~XQnr(JDOBQ0@LSv)nf(}s_44_Uu; z#uv8(pM3KX|9o?Uh0|i@X*3`N60vVmLMllS{WT?!(qCi$h*=0LGhip^E49VS!K86q zZU$E8TMkYpS#YSv)wsYt(hX4ww3YQD#e6ZT1Sz{c6)Y{kS*EAWYeoKgv-ceZ6UsrT zxOFGULc`H4RV*(E7=~)X_Qun!-BfBz?7>zr+MwiVR<3#nwUKtz{Je>1tqLz#e!M43 zFSU}w2F;V7gtTWU^-ZI-RDg1(lCr6)kLmFm>TmJ!M3v}%@RY)H%FUZ(-QGPRlNVS? zd3O*_jF#^3lkF`Fhd?5hNGl)x5b!zsuvU!^ceHNK=ep@-lGF~I zwFDnWcuQU@cIJbZtwS~uvD54Op7!n?^z%pf;6|$7t|xlRG|WAbnBBb$pW zy3I!HSn{M66@T3O%u@f6*0m`?+qR&fnKTStN6-S@?H&k(uBCFC+eZs-%qnV~xWC@A z+HA4LP|>0M7MFVZzT@I*#bhzVsL1we#r*V?xLxCv!o{9xQ*&_p+xXEBeVCvAtACl- zUVn|B{NMft@85ryfAvRxgd5jy(RVHHY%WMP$l+KE-Lp>C`dRiSy0Cy~~cyN9ncDcU+ubu-bNPHyv+${?}MNy2M(`GcVkx zS~OfcU2^-{33tyfSa)mAF4qjLz%bM46nxLMgDD5IBQyzXHA7HrhQM|R5F?dyOe(|7 z8IBswvQ{{&sEnnHo_m*T=B~mA*j!z4IBRGsi}!)q!HgS=iqolLdT^c4uW)M4(hO{M zqDqNX3>YFao#+vC$6K8Xr&{&&Y_auD+uouH?boooKg9CTAe z#IYB<6m5-I`v>_fZB0fDQZAfFu?8}F%mzjpR36Xrqg{O?$;t0tE0`A1CjtszHTY|{ zSx*m0fjp1*K11yh2r~Q?i_)I7V@s(qtjyn;ACKPkj43LTkWmtyc69!T5DxraQNEZu zs=SGoRt>Rae^2Oma!T}^e#_mKfmiUvBKIF3UXE1Cq8?L(x?$VH{O|~W{*Vw7&KY9x zqZXua%1g^vz%n?+%G#H`3yIm7O^Tl#hjG2s1>?dnCzu2LK)bD2ll zRkZ6B?bRh!RngSqqMAZvyWWmg)#Z5%+b#F+K4i7&XspKj$l1k;(}M{r2CAkZgvcEN zb#1wPbVfa`X&TLP+3>=Pw|V2Ww?HKpbxnJ5L7E@Kbjt7i*MEfSr~W=){FTr0+UI|b zzZL#GKlXo<_hzw@CFyqA54Hh|FyI#n5MY4z14$b;ZOeclNCqUxiv)2IWpXr};jEmsyQjOWyQ^!tb=O?a z8WDboh?7}E_{sM4!z55uxAJD5%yUk}xBS2V_y7Lgf1A6vZ*u3xKJ!&cHNQd+cIXZI zG%Z}N8;mWvdpO~lagG$8!mI>5Gf?EI1mo)+k1p33YmnBjtFy})i}jk-V#USD2?-6m z$Gcb*qn#0-`P6G19PIOCx#GdanzC%Ucyz+Ku+?=#;!!YYZhEqNjl&S0!%k|pFy`RpZ2 zSecf_3MRsEVJft!X+8hV%fCp!CX7s2*A4wa;_Gb@PK{Z7V~|cDQ^nq4pUZI(LghFYrWZQ9m;?n5U2cIrbcMc>x7lJllV3sJ`GRQQgsaY>; zvVlfOw;2ZKwm!zODP#)~^8 zUCpB#bmzQcmUkQhwQ&4@BF*#v=JAm=5>^*J(s0%WCEk$2ij4%#(>UQqkgS__mS(im z1De^4%o%KBePnKYr=KIp0tB2kzSlNhbg^n2b!{0+(5dJKObMS*bWD*tz)q?3^DW{6 zh($aVQiT`SuQHwzp+Y?uV)3+1*`)^yNm{Mg_yWz3+gp(#tGl*lxv zTrDuIK_wE~Hu#R3z-p6T^GPYmc)G{@$zybyGuhwAwk=9{O)arSGLTZTvpa#-QkMmf z>J`&L4=q~GuNJJVX4$kPZNb&mn$cc`ST*b%Tw~Grn|86Nup+@&Xq~_s!^wjO45$0t zJQ(qd|H>~j*xToi{>g81_TCe|`IRs7OMmtk$$AGICOxK~evNt2Fk9CwiiTmP*cs%E z28r*DK`_vQX(rH8u_zkOmWKOhbHC}^22<5k*05L?Jid3I^NTr+bN!9#bRBNB+8RA^e!j! zEBYVaV|h8l6Vb!W83hWE7RuI;3^SY-h$hqzQXOgwKFD^;8_Q&z^33%KpQ$Z>yej$Q z53U&R$ zFQRM92n|r)z_%@^FykcF>a3S{kM$M-K8W%QxEnatc_vA465CE_`+NG}w2=wz;Wbv% zeQIQI45Cxcjq^9+TRY_o5f8V4#kU;;h(HPrg0G$1p+i-I5e&nMH$7gF#@_|JA{ zIgjx9lRL2glQxm?ci&hBNYiyfX7P{R8kHnNGtNfWiVmVeXo}vD!C*+Unt2u2D8a52 zZX2SBYpd(vk<3>GS~$|wOUD*dg{uGnAOJ~3K~y7xb270jRbiWkh4GUJGwq$scBCI6 zwoaRWE1QTZrV@^_Xwj<$a(L)dRAK}c=*xi+wJ9w+go#o@4pWshMS*P^z_WTpkcPKG z!X?&{oFM1}NqXZE!^w#IZ@o$0&%w0xM`PASf!neY&RXUd7o>^g^uzn??v5#?L6{QL zG&D{z?Mog#Tq31nJf2cq&9NAyPT1K!q-+>BRt5Wqnp{f?EqU$pKf}#u z@9@9<4}Y6~@lU_P3wN*c(o5jf9(k_lrIP6&Wmy^O){$wyX^gS-H0&ghD8*&j^5LxJ z;n|YPwA6LYdbOr*T4tAXPCxjNtND`t?k0`$r75X zVZ1x$Xm?B=W~eO7iq*R0@!2^KADp74;N!2p!13OgJWHsHk_Q)Os66N5a?Zoc71yud zWRTJaNsGA58 zpj|(-&HhNequW5i0C$PQc5NW;gY9=D3Mnk3e#%8tQY;&?ehQ)MyJK2~386$|Eqt)x ztV3zN*%7UG1Tt0r_a+qZt%=o#5RnHX;k<)+YJNfd@*&e|5mb{Y&A~B^Nc*c?hRS!FM=69Tu;{x;9gT4m)-eFDy(L4jJ{bQ$l|qWGMHbI9LRObEvXP?- z4j^utm}sk`67*9sb_75o*bDCmJ z+UwCei&UFoMnXtdvo(8@HFs|AllBsJ$0HWAnyb7|ueO|D6qM^4XBuW@gEcjIHAmYu z>8OWoy|c4IP}LP#nlj2Wdc6#1Vci9PPLoMTPe}llKxw~<+K_6A2Bg$MH_vdoZg}(2f(K`Fq_tdKoU>RgX$+KAh0+P> z&X|MonDX?5YPsarD=%_%^E&;VU3%jQN(tWl=C^rr{{j7@L-r2#c&{(_6ahM1aCUJ?xmr`#hMW64tW?SmP6}LNS(}C%=SxJjrnWUYVBR_`mBvC( zDH7!~POH2%RN7C!bogu)2~ufi!B2bjeF-z zh%i*hGU(z>;%IEaMmsOQ##$R}!sc`1wRCJ8i?DbFZld6=2s_ckyo~_l zMduN-k63DoZAkvU`!ujyR02?%ayTK+Gi+V?;6@8CRU$=~>e)blM0lpuY*C_tJPpzZ z5SS@0$iVx>QpEs9fQS;*#%(s05Z&>&Gv{s%h|qUo9nIB>{ANih`dy|W@J)}KlZOBuSbunm)tn`|omj@`$WI0?7dhBJ9FYhZ^-@N? zgwxrKi+RCdkn{1^o@Z5*oS)CAtss$xx4-{=);A8gb?XMtf8mp;{(wcbB>OtJi55z-h&6E%F&+Oho-_g$v`?P*W!eu6@nIrvJRS%xl7@r zX|*ZzS!>XV#z}#*#+MlT2{*2fcz#jx{mYUcynD&PKr-_iaBu%Ub844?K*RN6KBg}ShNGR5K!C&~E);N^fMjS*JOm?T< zU9PylEx=d4w=4e2L{AfvrwEB{U-p>w#C8QK#E(>~e*BM*tdX#Im@>H0_#1=8 z*-hH%gz#E8T_cV_ijbYqi9-dds$->dcJ}sYA3Q*Z>10YrdR|ET9e!Yx5G>X;#yAFA zpp(#m6m581q*7sx#ROqBC493Wp*Dd4;v_UYrP1JTvI?Qh_RZH4%2i2Ttsu|Cxx~oC zb(?QHijmIxUJujKR28iW;&ehFveSX65&UGFNoiB{_EeMsn`76 zpZT*SdgyWQAY+p%ixz^SvYanUK0LkRl+d(o>(_Xg&+*hFLQAnQAcN5te&259iTiiT zPzVP=DbgO~>xQCk$=5CUC_x0>DdMNO4Q)SaLUq4Xp})%7&hT36gT2_G=$v;}IM+=v z^tM=bfgb@LD_cQ3nPB&iXu??DF6a-8t!`9oa3UfEq&Tm&7qb!X09?FG-bUb^h!8&H zjqKm}dl_I!>zr4wb{k~HhCRJK${|W1ML*N+TO4Qa3i^YeutvhGV#vq-H$)7yI(s))$Y(7GEs<2Xo(X@eil_#OGF!E*nM|oKl zDUe7KB~h)9;$&0{6{5p4Gv*g(46=;FqeB*LOHo#gCKHk* zXT6wFCl$$PhdixW)HTCACrLHRwM_e(o~+R}V{h+>|L8yaYy9os`tSLB|MTAg3qSua z{mTfQGiwA|TCkGBIv&p}?q4i<>z#X?onFzlhW;?;==u?PnzAd4p=Pq@G`~Gam5L%Xe5-6=f5Q zF^ZFAiLM`UIT&%{XqOjn>~r&A>M5AkalWj0a=GGazGOMO#5E;N)zI1{gX|8YeoE1_ ztc#M}RN}E=ydAbI&(ZP!8eArupKr0Okefw>~o6M*{D-*$> zpHMf3)uJNpCm|>d0b-&9JQj{8Ax`@1_NEGxMuQ{RjKPIyv~kg)hG;%!XfB+GQkVuR zog%JXr;yo(@dO)oSTy<(5{~;E@2Da<$2$Q!$jWC1gnJbniSX?Ro_8ra1kkumhxw-K zJSt>_ev)8Yx<+CrHtNN}aeec*;H~5*tdTH2q>6*2zyn*}=(}x~jM!-8h!~}BXmi%V zDj(7t4KcGT6b{<(IxTRmLn~j1ov$0Lwe({_971%p=^NRknwCT<1nt)IaT5_<6P|Z| zhDqx-+CMh@QG}Nm2eT{m8aj?nmPSO;MoJ1QE=D?)Q*NqqV|W z>-#$D#$QXonHHrrQfZ`=tc!vq>rvN@H!f1Kf9qLhZx`KtDAx;wu#5+aUb`fh3CluY zdwZnS3Nk^vUNRaCc;=aXmRD<KLen!SBg znzA?QdFN>zWzztTbU5WN{gr>8uilvO&;R#-NY+dE?9coxxlCA@jM=*3{YPhf`<=(! zKf6LUhUJ3?Om@Z`KYNp%>6F!K#iPe3jCvWjZymEg>4##t>at5Meac_eHA2G0Y|cCH zyvMjdU~js^Kl|$U_{7IvV>B6a_vSJ8-@DJE9`dml?lQ&jwGi#5>VkgmZc1K$1M zjEmWtSD(MZFwZd(u2vPZ`I^OifodDXYEE%^gYnP!5{fQ+DI7o>y=vk)G~??T9GECi{?`KGxQS z?=qO5%svo8%^_S!8`4B2WoV8Gk$!w_NKv=5l89GYXIWaw-u@nDHus`st?{X=utD+G z`h{B>211Y}q2A&1Vu-`2!qSM&B+=4;wh!WgkO0L^=3+f0X#EKBlmqcE@#mo>G*@$y z;}YkRF2dTLfeuj5X1Mi|D$%6h&1!54+D?FD`lV=sO(j|12-uJ!VD5>7t@P>Qg(#`t%H8Dh8tgMGFVl z_j&T*L)NZEt>z>jyiIa`pJa7Gt`v<{3|@Pk5{Tv>j?=qXOSS;7nPE!>H zM+dv4S;~A})6)qiRg?&v5sdSkTBMk!q;3bSD?>juR8`CQY|W#yE2^@gna?m~!D2Qi zNiBn&0kg88EC=lEChSaidGo#d*rw&iYEHGdLR!O)5GW!29FXWh02!wI*#Pqj=Wv)! zaTyWVc-9+dD8Ol{d-b;{4d{Nj~xQ==&BRasQF5#k-$M*Mg-k}N!wuy9G z0ZRF6)7s9#7DWrw1M10?$_b3~#cRtZ7~E)F(RF`EyJG`{9*Jbp`B)bV;SL!@H@&ZO z-B74#^x4WhgaC;|hz(@rvyEs)d<|6x_)H1c*}>R={1N((k2nMAARw{TMCgCj>FltT zvW3@gCY^2caT*7!{tm-5#Wa-$kd9RbnH02(lB`%@)2V0LZry!{!&Vjb*%?Wy>F-YI?Mx`v zB~8l5GqVyjGtlsg7)y)*6lZv^A8{K_y5P= z*me)W3^H?*Wmdlt+szs@WAy+v2oh*zeO;4a-V!eC>$z_!hOXaP^q}Ti@c~ z8(*RM`gahjVsfyLzIhw@;_HliFQ9wJw5E@3L5FLsrC~VO;n~mpMN)0~oqzOqQS#s7 z`mO7nJ$fH0CDTcUU`Re3aP7u1d(#o4UWy3or=NPLAkZ!lIC9}=Tf^7ic$X)$igYl- znTBC6WjGi@x#ZezA7v%$)rvIDFcxNwXXW>VA#)|Gas_E0+J-^i=WMZJFdR}ACHs>h zmGHVm#yTFIFSuIQv=+`UE~zh`kPB#q;9!53m!5x)bi6~|tSOA(#=$-(k54!{-XnSU zO&U{zXi1d7v~*C3aiE27rt1uh4^g4T(^;kJf*G%H?bo(*fyI<4L?U_p)(+phSaVj_ zJUE#%o}^?$=|vX1?0?E9D&pulS(&=ggO~s(mMg6Oo3A6^8hHNa>0z-|+wLUv@t;HZ{bc#DXVogHZ8n3rLuM+6==4l7>LK#UOrt-ShlEVg$x zrK_vDt|75Ag&)!5qnk)LkBkeqiD+E(!h!Q1-w>Tj{EvuuV>I9XDlTNka5Ba`IYkMH zu`SX$OzT*cEylt~dwAH-8Su_YX|>rjvAt7tA4M(&wQ*rqGCoS{<_?Ik*!=N236i+D zEFkf+^Fp#J8`AkDa(@R;EZSr{I0tn_J{-{78I$&UNGWL>KS@qXL7Jo?(C8zDS4vlWnQjcNY7lIFBVMtJ+xL}8miTjlU2$4A3i1-PPlP% z4=E*sRI!r@zI*Q>4neLZmxX3oRmTi5p3KisFBoswxmUpC~nW|}z6 z$s@^ zBYwNQ;QNb;?42`SczGXf4Pln_<`E55u$Ink#a>TYFXzb};k_FPpE91PdhQjK>+2#L^=rgEs8*EtsnMkqfz z!fo{AeB$oyfLF+lE=qLvARgae7PmpQ@gy4&0=zCUa2rSAf_X7Eik57>FXl}`kSa+c z1+8^nsUkr55mD&QAMbFccLcj1Q6r)H)nEP9|MJKEp?5zcS>Il4bf==tWWYO##l&_ZQF@NE5|k=g@bgZ=H*DhAdI+9v{&g z4M}p(k}^$$H7z(FO_ybbZTx81tlvj#kB2LrP^>~`q7_N62NF!vl8;8765KQp*l5c~ zinDL|v8C;B#*JU#{PuSAY;BRNt9qP=wXH8s;HUISFC4q?DC4twG@jP zZC%mpXH3Qe_V#vgQls!aJXfod)yWC=Uwj31@enazqw0prT2=z?Ny{4OIl-$U<>1x` zohx5_HeM7_WtorQ0i^?E6^qQ)2M`43qNHS`;L%0NliFg}HM?4q1S+h<7)R4uq;;hI1c&PsbtAK|OWk9b zFJ#BS>cm%F5OwqzQfE!#mvlk<&KgIZ_E_Dz%S!feQgm5|Kh8#_#W{jd>L#0r8H9<< zPP>7-;tm#K!AX`$yC=2{^q(n1)b9j`t-V}{R-}Wzmu_hr?@XMdDayc(b}SzV&c5yIAnkC*PyHL$`E$Sg z=g50~-hcZ;-ujbw&}q)`jRA+_b9P4!i$%p~dc^+W5zaL9MkA{A($9&PzObKY$sp5A zdMR=|LBIYw`>(!4zgmzj=Jb~Z=3>EvZ@$Il*T2SKai6nl#@pvhPR`dF)dRJCDoalz4ahgK-g7HgaotkxwY3B5s| zUaA=la`q=9(o~bA8JFvt^NS_R<%*=Ku*Hgceo3#Fa{KlT?!NpIy?%y~DW%A0jKewa zeAU?r>)-zpdT|c(5?31v=O~rreJqWD0fJXl!v669k%G!oT!1L0QXQjE0M?jpYMuy; z4v{Eq-6EVoC5mBD^Zj{+G=j8h*+1@+<{9tQzrxC12jI0&JYYPni3}kT=tzG~w*KZtZPdz z6(pIzQ7-g{#342~*J(?&m0=y~5E+n3!nt~^vuX`$f66)?dUl3zB+fIZ%5{k`hNf+4 z>jq=|u%Il@5YC~6z_v9yNl_wX6jI@oq-|QN~2;?2Mz&wH#hMCl;LPXQ8%nQvA@rfd0(Xa|3DNCIXN=Fd zOwhZ!^(-ruZSC_w&cQp84)F+QThZWgQbOdq>stS%l#+Lse{I~5~ zq-RETvxH+d;qzn?Tca;8k=C*bUc9daex$aKy!`wAbkq}N5VnhSrZKD=N3QV>#EFh8 z-w8X$f`{-t{jzm5!b4b@3JXVhCPmpg`n!E*`Hrt+U{E-!qM)tHu0RJs+ma?e!%%5X zKJ3#Q^hxp_S(ag~K`GreIk~o_t!vVL&(~0dpefcQc@J=Cr4d>o5iB2V90-#+qt`Cb zG?bU8jHV-=|M_Hpd)_qf;mtE_B|LV?z1tl`9^mpwlZ~}Z!6uNE9gAvX^gaD{8#URq0&I>Y19TT`jPy;9-MkPs zjxVyRHZ>9#?4O6U;`a(x(367#)Hi=$p_Yo_?&i2ZuE$5>K>pF+Y)L`q_QTcNdNcl0b z>&B5N$TGEwrnVLh&O-(sGIEryqZF|Q5+WHPI@Jc92(CuEv}HxRT2QXmfI#X1k+m&K z`npKk>rq!VI7_CbcLLJkOoK`igp{Zxr7lZM-GFIPX-bl12xn=^iownl(>7k^)Pb{x z#p9%NAo;bHmw#o#{&a%YnpIJgq&d&L_#&+yP&&ovV28vtJb2@~oZo+!XP$e8TX$|T z(JN9{cx|jKXWZ{G9VVoSKW~Sx{jjskbYN&tPne%xa`yNFEd|q^AtT|~5su}Dr(Asf z8{9qYGdw<^$alE2GhlvspYMI|hfK#KZr{4Y&Ln4cbpj}yPB1E`QVC>z`n^8GJY!ju zh+@WAI+jMVY+!CRt+kBDBL>4E5`}9Gyr16m>_w5yt{dCSnkkG;U&J zpP)+@LLJh!mbx)WNkKP8p@@slK{GGcLQH_ z3(+qW-*Cv&De@LZ=^-x%PGIu^rq@H2CApJa2}97=4SG3S5mdN49h?QAH~euCZmtqu zm(8{YmFlhHWC*E(dY3QiiKk}!Y`(IOk}?T)v7%qEC|16v5uKl3^AgciC=E%!Pt*9> zAH7sF%rv!u^?Zq|EAK1^W6;_!bgeLW3ah|*HV)B&K~*>CfLCwYy&%mqbW))Nm?R^~ zy%c-dHca=X9NhW~eDJ|L=$&)2{(CGQy~8(t=l`Jj_;-2f+tL^6nO6p>c}#XMUN<{yuwO{zERm`5m6T`H-{I8IzqcLoLZ&Lt$FJ_22xr9Dnmq zIQZqiNO}8Ne)cmz!$0}`-{nic{d?@}9B}i6mod+jJh)6atsGfjVwED1kO_-(hDRUV z(C2iBNw=+fwK`)i;WSY}uMPoFn z66_8%k`{y}%M{DCp{)EInp6r_RY|>E(X3Vs52rLjl1sxNZP*$2cr=sDO3S2|Q#1xw zEE$P{>f{trRY(hM-G*i5dp|N9YX_1Nm5WYEv9Wf^z#&0LkG|JdE@~)jBIrhWO0MgY3I_-!k;0F@ zEvlBL@BT@N-nwnPLy{uo4Q>7!`dT2%71W|bf?xt!^~wS)}}6{9tO8fXPY zQPEpn;Og9u2h|F&&^m0}l4c1?YfKX+#wjoK7b|k6sgVNGB=P4Y1! z=|mzu?KdHEi>=)l2_YqQ)3U;o1}uW!Ag8#fxLg#7CTHjRT{3r@{O~&Y?Uy;Z_Z`0c z#rOE`*ZwY__^Fq9{WCwuX!n@oVGm-Oe<)8jv-{KGc&wtEc z_{$kP`@5X33x*;`I6>VS>aynCKUU)MP>YCNu5YW;~Xah zI=#VszU2DB4#FC6V5|WFx26Nub%W57R7s43b!DloU|rUD%`VCOV#fT*W3EolIlgwl zbFaL@FmW919#O8}raw61aQ}$8NH7TY2RXB|1v||-?qWt_eZ9&6QT)?6z=p+WeYdmk zWAerjw=vLhk!@y#`!z)(P)gC5#y26h-Z43;7)*NH>92URXea^ao~DEfA%ZqtFm^7m z5Q$B8e$V>C^QJuF*OlL2(eOw8HV+Yl$|QNFDc3F4x?07?O@D8UdyKMNxo!YLWb0eEtM`x4bUw+TY*aZ+W z4n-vWM9CEYZ#TXK?{o=lf}{FTi}~Yxe58$pQ8Cuj=4^*` zM$hX#vUe(RJY>9?{t=gJ%&leTM40SggdlOg5zxd1jK5LVIXn_S!5Ww|(EIe&~vZZc~#%F3`d3E$4|@bLBlpBV0Pc>G=V-+jQpx~@^Ec9 zy;!iQT5e26JXy9Z8pF}y4k}Gp6&1^}_QVV+>Gk_)rD&~13(3*$ggn)_7W!Gj$@vvc zYZ+%CQq8<*X&ZwDB?C~znhUNstl zm7zh-`e@q*Wm@MPXi0C7v)fm2;fva~HNLj;)Wdbu*3MpS8Fj1;LeU%N(9KcbSlNw( z34co|81z%tr5`$#l?{nXI$HcwpA~{9f9z<)B?!9_mJE=Z!(yeP8t$+hOgcm>HZ4YN zE4Nkeh|fjGXkC;Y+0-q%TB(RdcW^d9Q{pLHuX9i#!Ra7uPuTItb@<>ma@C?JWfUm! z>@DxGTjx5pa$(sZ9UtN2BWomVXQqR&yqKu%Xl(xGcr4e-kg0?l=9~x$)?p!qMyU>8 z6o7B>{eX1$lAhh=x!nQF(*=*-KVw!K4%!*H9`NPA_m8O-bMCx$$Q$jP?|=6m^4_=T zXGaWP`waTl>s&NBCxzELn=Mvco?nvmM@)7mTopC0G+t8B`dZfhWJsPV9FDeiSYtSx z_K`SRp~w>$<%+g-0mk=g$YpIPs)o`CmbLLCC#o7-EE!12(n*rRka_J$`y-y5KBUL|p#2Py;VAP?u(h=71~=Lq$;EjcB8rHzQLTu(E!BC6wteQZPKE(J*%vXG*oUbQ5dhJ=lC>gY$?%T*B7x`h%5tv1Hjcs)In_bHBV z&_sDt=ik>!fNVduvWSR`M7fb@90Z#z#Mdk$;V0^3Z9(eMVTy2XHbBb8z;xN0h}*wA z$w>R%jK=mqM})=!!g!=%d|R^jlQxm?58hs2Z7}FvYPcEgD4d_?f$2u|L0quz>9s_+ zQM`dwQcyTeHW=Wl6^RfOk!l+}{|3k0qUJ^8iU?BFQC=k!#0Z-rq!mI+Tx4r)A5(}w zRR`?QBH;}~q6N*WVmxU%$Dz_>qd627iP9R|tU*hZ9^%>>tGvv7lv)tdLlb4?MIv=z z#DE_>)iyOvm}V%1AjvbYRxIphRA~6lP1|6NqiPKg&X!E~52=mix#ync$v3`7Q|z!ZWN%D9xJkNxz~%k#@%A^q$}_M06i2u30DV6H+-oeY;{I&S zl^xPg2NcT$HM++6qwk=eT#{&S%$|Mq8W$H!ih0ejt+<&fzVg5R9HjwakXyoMHr zk*axOXN*O{POr~G4yl^flS2}XYYW;(_hD5)W3a|&&AvYXTI*<>!w+e;zHTl9HiY#gVxV13h|O;Xl- zN0e!=8<~xB-Pr1<2RgY9d>@%`J2)pu)RJGNl5fD)(18?I@VQ(r-FyTp1RxqW_Of7HVcc8S;*Lk z7}Y_8lBn21*BlOOM4%~pC#VxixvtomR9p#AI`Mcr0;!bm*KjG)8G3n!!BMQ&NTq3; z2Joyeg`XpDtnDDUG)QCHra=fvz4p!{&2xm3G<6L?l5H{&=PdKtCF9AIb={(S1E!M^ zS&}l$6`%arbA0dKV=k6!M3OS>B^awI8YpqJ$qwy!fKoFwIg?j!v9o-O`+xGsJp9fd z^XeBq#RrQYFxdY%AG`ZW8VeWeIki%_XP@KtOF!hpvl*ukE}3b??rz3F3zDJ2xE^w~ zqM0Q8$?yFkcYfjLczJJ+cYkn&{OJQu-guLPw8z2pfDe@5B;(KI~&{0j^Yk4Us*lqZPt5@E(%t_r4U%|YIBAtkfLlD$ESa}D;x6PQ;hx2bUm zghxf&5LAS~DKdOO_^8`jr1Vq%BrymHi`p6wV>uC+eIY>8Uhq%iyS2&uDB%a|md14E zar5YWici~PWZoqhVKe!9iTe??2H4vdZG@)3@Ks^O`J1CvUx1ZsW8wc z&Liq7U?P5RHu!U({NbEuR9F$B61wBcNcAh$yVIjsq7Z%#id0_HNh*m<6NJ)GHr+h+_$Z2!#srCVrMPkH7K1^K zl|JgZHW@Mf_|VIg7d28!%G!{o5@Q{8?PyyGdcYeOihCWc8N>ZU4sX7Kl_@8wrGNXFmlDD0_ugZ5cEz$NNn}oz)>P{y<6JYK#F;+d z`ok~t+MoXdFTVUdZ@+n;SN_V+z--1#(=o@-?ek=&(U0EaWN@8jZ-jQfAul#!P6s*t zq~>f<(S*=LNkK1D)CP$$N=tuSp1T82@#n~XZmHN#Zmgk(K0VQ+i4 zcAzH{!=Op4@hS+GgiL`|RghM5gL7s3?S<2dwRR1@5Zx(FXah>UX zIqc~Scdoj(P*p$`3IhR(ASpr=!9kP+DkODVt+pJZB)41LmK+W{!Vi9Eha;>PKlsUh z=odR=N4V`a-BR1#t)XcRlw^q#Nr3<-fFJ>4r~+!Py7O?xJ!GaIGIQ^9L3Q{|^}rof zx9XgG&OUke&djy`f35W|-_BSB{wkpA>Ol|xc84MV2Y++Rrw1H_ia36SY z!{IGk(C$6$_vp}$3>1_5KIWq{iP40#cCj_CqJ1u6wf6aTTtVtZ2x1QxAqYth?PU+r z?VP%%UEJou91pA`;rLcc|6(u-tqUXCi`mLY;}=4kG2~)utvprG3`X6XMa0n_B807+L--VqR)@zqA0(B^qZk*0{~bje#ujsTRp>ooecuS<1Zn#n zwF*V zFgcsLLFYM1mZEe*lIPUMAQFvEk~ZKDo*y?B27>|Pvc@<(A1)+R4Y|@F980}~evx3T z7nm%YhI#2JH6;Yw2Pae}As;MrOQnp=oQKb?@yVaNz}s)Uz}LU>*F5~_Gdz}My!O>U z=b=ZR;=&Vy<5IFyC0x6Dhfn^!pGHW@ zOTYUU{Lu5CVdVcO)pcFwO4HJ zrwT0vv&t~58eFP;{{|77lS#?kSf;gMJZqSh71QaI$!J2=81}cf>6?c$6&d~-oXtHrxTK!_o?=eNR0twP(issXo=Ip7ibEH4tiEf z(;9yvMd1AXtnwh%dDY!m%;y}A2H|rjd{ZT9k$|ZypZp;uOT7fABxCd59VxE8U=Tve z>G#DE?1Cb1a0vZcUZB!irXYI%*4N?)$TE$SbLLKWsN55hh86Iq4|?r*l$GpmEt(s=fcm{M7<|~?p*6PcF3%yuwA>IovMc+)Pco4 zCTv1ZL=+V-p=;0W9h*~kfJi;!x@@qM8-neVAGnT$1t0h)6P)#%S1Tg3s-jTu?CMMOv+$c#a3wU}#fU8qxu zsmTF_U}$I&?Ww~r0)Z_J!+OHOd`2CpDG&cGCP=fF<=h+0y7B>dm5}rbR<<^2=5s$O zjisq-R2q3*d=o0Ikx5FL7oa3cNK~4(lwmw{mSNI@G)p+s%Nb8gpC)Jx&Pb-FX%U}A zFs~cR%8T-8DX1E6Oss{oYs+Lw!ellfU0dT$=9txeEh$+i2~$qB-iWI{1-1SfM%-ALY-Xx_Yc%e3484;m25c^ep%O)j#KnU;PzkPdvrmAO9IEmzEh1 z23VvIK4w4+qFdiNJW!`!9tDL>|4!SIHK@MIgk_Jbje8$ua zyk?dFD+NOPz8evF2-Rf_hCe_sEY=6)ZQbCMLL?e$6Jh}t8TM4EHB0>zDIG`i`c#TH zVXl6^3%;Pt8_+WVLAsq7gl;`HK-jMR?c%uutvkpPcIP#!HmGUCAd!IW6dwe%3z~NC z#?%($B=vBKNj{_^0HK!MXt$4$@w9-F77fY*vWjZefw*c7!ot^YtK!=;2wLONp)Gj*z}6RroA?-wP@3c{tvC3pxZST2v%}*FLAX{)5+%Fa*$L=Z(nFW5dts7N7=) zWkC`FfwjJ2RIEfbE!XNo@|5#h|574sgsI*e6K-MhegCi`Jnib`7U4n&Hsg!V!(y{UHa!Ql5P|?U**Rp; z>r*XBE{q&E-@eP2U%$pr{qnQy7SHkrzw;%&dt)E-f4#^PAHKrXd;9GE>7Q`rS28A9 z%5c6%q8?^~IMvX{XU6$!V6AN{jK^hz(q4w8tPS(VP#fok?y3gcII42W{A7&4vE(Lv z@{x07=>c~SC-l`4%gY;(=1eoeL6e}6lvP91)MROAjY#}B zOB@DA;sl8cRmg#|_0l52gEl6tDW4VP8ryoerfN`GhzBT%YrGtf41Ge3*5tj6o)%0> zvlum4B#T-vEwaG^I$=@2JJP*iVNr#Rv~}PXe!8$Ign)i8VXtbatfQP821~Tar$qze zG`&n%qDCc5dP~ejf{Ae)v9S3Er^$+TRP9(}yWnV)V?!ywNiSHR@W$9XM7nN|ik}5R zEhAWzMZ42=77W>>GCG_wyEFvJ!(42~1S~2C`&%L2bDjV8j|W-@a#{-6-zbMK**Afz z@|5a=XqxDPOpCxSJ|~0-8v5Y0LTCkzKeu%*=!k@PN%RirQf*sY8mOz*=xDE+X&Pb! zwrC03i72EDRlL67M+0+c5qsNoM)USI{{Q?c&;G=R`8&V%S^nhz_+6&k6ZU@pW#0d@ zpXB~`-e&URU(*{MVU8~{Sh|H+d6==&t@jzFvK>&{5EK;-p%it@x@s)rdCh2AF`i5* zXLGDE%#V*rv|zZj%DKyDIj$>KYRh2dEQhjBO3JF6fl$oS0aj{?R8!Xp}1*oiP7L8eLQt!#aElafAV zI3R4HELkt7pJ?t*rVJMLCD+n8u3I;L0TWY8RiJO%1ef@pHX+5e4xb;8_h3W}+JtlY z&{&lK03ZNKL_t)hiDWsEj7vjdEXH`r^HWEpjDlks5lqu7nCjfqu5`m_;}>mKm~9b3 zyUEA8lCWjR%^MeuMfaVgTZ~_{$KT`HmnudY@3v~dCx=X1!=2$(o_X^R)sB9NJed0WyE z&aH6Pgc~j*;0QLsPjtir1`0P@Do;vzWZR|f!s!=AT0w`Wqr#>FFTJ1@(XWw8;pPp) za!isIE&5VYf{-YsXc|Ky6B?ONPrSFAB^gbSoG?v;PBg8zBP2;tQ1pAu=A|E6=o4X@ z223L-cIM`FR7zp{+$@u}#ClXvAbPLs;pv zfUun4NCw(BxGF2sBBR*cV&&3#?74O7K~8>l71dMZn-|zrlB4m6w_bb|Q4D!0yu{MoCDtyk@#7!+G}m9=;mtSRWluI7l@*8AuafnK-2BT|S$g5S+_<;P z@#Z>rtYGbp8!SKb6#HNMCU!K1dO-Qo*IEDNU&SqLGHxVw?T~@ym{$!=@BmGS9mFP4 zlge^9F4^8WWHy;1aZHbosHal~Zp6o*yv!pP)|gnq)Hd|8go(^KsT{pLp^+JxQb;Ya zK%EGb9gvUqxqEm_V>$^ODM4xpLQz{o6XOaBq;=?25f@JMW1R65%mq~kfzQ%2^BQLj zI@2L`A+dGib$J@wQb0;dYGo+2qC$qg6{pv0D`gT_h687fXAa`RYXiLt3$Z0-;sT7u zW?|tuA5a%gFw7E0mBCnODudG9KqArP{{%L|0ZKAYGisHD-CMMSaP50sMJwId7X0wEGo$os6h$ml&!t>XOeiPAR28O>)beBvZ#mMUhfY%xC#dQg=PX(& zDq}FFA1vwuc!JSHE{U|Q20O|d5v%&f*#jn`jF60in4t0)>krC1D3 zG&IuZ*{6*oE&7PzDy4wYY|i~RZ!&rHEq1qesGEihm(TO~bI-E&(dW3ZwTrvC!_8Z} zyj)DU@X%T6yZ3l#G60i6Y`^Eq=8$YuGP}CV?z<=S&z5o1{^*O`yR}0P z$<6I;5(JHH7|Mj1t$6YJAs>F+aw7eJDvIiWTol|DJ&sW{R?t|O)Sf&@ zwHMN>ouf34!%4;7(S*r#MqO1T!ZA5Kz%(^T$C=f2&JJLZI8v2jjl?AdsZ*5BGB$pG zBQ2)!$|Cd1a(w?j**Ct18=WAGL1~3dA?;~Is=ec698H*Cg$3;_I#r$u37e>QibT7X zq?9=0u(d$~jj`CqB9e%bEv_-Rs=xDZx>T+HD|Cr@b#! zc%M3)Ths~Zoi!q|O ztF+HYfE6Cc+Lnl1PWy>Iru1Ir-54m3!}9rHe!NX!8)9m8q>fuPfCXgYr1Nz?;qzr+ zPNWbBdMfol;sWgC%gpaw#GBao+!31bN!3_>7+BC3sEj&vkag0UDn z-JL~m!#TgY80(cy#-I7e%xy(>v_tRyO$K{A6i0`M*%)COoK(y# z%o|I3JfS(BA;vSzYzo$pWxivat4hpx2O%s4u%;vifm0g&$Qp-Ma_wZwpa1JWMf~e8 z@T0%-i(LBHkE7C;xqf$t*WbR$QkpZB1vlP3=KWf+p25bmXGn()#tNFdJN()|`E~xE z-~P8;{oYL;atVXA4eG-Y_l^%KQM|Hujid1aJqM3`@M$ib(Uj_d^5(Zthc{We^ehv% zOxZ}PhPGH#3Q1)QW$oBGoUk)0nM`Ncd5M{haMKfX-OwK{@#qsj#OB(N{rNE`hb3#v z8EKm1q$ZP!$+V==UgXi?v-rkkLp5(0)Kkjaw~;~MQb>nN6uO@yl%Jbs=Id+(zPC&w z1iJ8Td_%dK-`K4S8dCnRscMArioQ}vY*`_k0y~G&;>xD0si+%J8jK*-I%uf9cQv_F z|HgS7*Q4<8fiBkJJk=8&tVnMO0@FbIy4Ft&;6^8kLMz6$rmliwgmpex6c{gev&BcDoEJ0;6WV=2Y0Uql8IoNPzcdXD;gAMOk&#ey{HOND{A=*&@WGHt4~)W6Qg$&A5sL`B6hQCT zbhFsT-@65r;Z9F#hzQ0%Zk)iR8CrN)XdDZzFY%MZby-U>5GbVdR-&Z|!uiAdDvRfq zL(s4V%Sr}KAb(D!1k&I$v051H1@4^m!A>nCjrODN%_k&TjS;@DgEd}7RVtsdZ0m|7 zNtmA)gqZvB*pBHYsSkLIC}WQ zxOzr)bcilzq^3dumC6{+Y98Ic#^CxJWcP044yI66l%~Yh7Da-P83>DYhQ>8GSD{>u z*}21#(5zJglALPNu=6kf4e1kCxbl-f!P%W1Cbw?!=9|~Jy?4aO32x5~Pt}@>UpeH= z*&T+r_c-_IpQ0XL;}`$S&+=!#^~aR2-r}{}`{d^zqLh-E6O0c>T;HGY(@$-2_1kZu z>|>mJa+AHUeVuH$NpEQjJP`C660z3W7w3l*3jgAfX18Z;`lzVz#-u|Y~COm(SnmBr2*OzE3A#kzyV zx~ohHaw(X8UkXrn2wd3Mq7G0;+xn<|EYkHmvXBZF^}V8}9#&U$rdsVQ?{+gR62?_S z-8furaZ0p$S6wkyFepOM2#L{Y=#1DE4|a|qA$uv%+zY{M2nCf3L2ws`+F_N}khDL8 z$Lj)Bb-Ip(_Hq2K#>PisOmR<(&%4f$h$tr0&&= z;XEvbc5{zA@Ovv{I}c{@*89UaXnF&*>?WU$81ub>Il8G5gM+P7Z-~JN>#3>QIb7e=mA04hsy<2l2@lu9qP5ZyaklDe$W&QS}6 zZ46E2(`ulq#|ZZajdG?2RI?FkKbj@boH2gR`8}g54TsMls#lVQ>G0U7J%|kEojCV=@gV+uN*e zZgBC^1zfpq*@lM&pSGbV2H)S)3kAqSbt_uzb4Sq?S2r)5dPB{6FOuO z)Fu{~Cb};d(M0^e=pII691;Xt$}hxKl?37Z{WUEWPB1_Z=6GO*gp)g(!NaD#G3^oN zr&EDe3LId2Jz1D|1PB_kP&!!Jo{B2X$)!SyP-EdbDB99UGHT4wohMFCAzDdl-&iK3 z_Zqqh=M?SCqJ!&7IdUNwIY;AsL7}qv4L}A8N%+a45=k{OESo8Z$uJmA>nr1ddhUBt zt3;sFglak`8}^Ak-K9?2EUO|*aCJjjRyZ6<*+ zb4Z<1&Sp3ym9427gB6nLbcPU;$#}xPl)RgsrC$F4(;HLfcX!x7C>fWMniYhGR5l1x zqfA3z8U}O2+OlR-8lK!3aCCi_ES+hn~2^MkXk#DNk*!apP#j z&G8s9=<&6&<%u^ZY;5$H{n1NYxOa``E??w@jR9}nxX;SFSE(PlM4>e&y*_W14f(Y@ z9KX5G&VT<0yziM!F8|UmQSaWNdi6^@^x@~&8uaOjntd~5=Z%*by!b61{nYc^A3nrf z2+rMohgwuzy!brvXM1{Nxa36_RfofbE; zIPaz3fxLs`T)SzBU~q7dCmJmU&0?$qS~Sy=26U*U4HPUOo^G>@S#7d462dGxj`8K5 zRq&LtA8RkwjGCIdHY84;+K^lJ8W2iglLT~fincmEium3zmiMq1Zo#Ozc07K7Es}__ zp7v`7>N=iZbk{p7QJnsg9Y4}$oQC(>_H!2Yk@z{bi=&FbycpLZxZ@jw?V}&CLc-&D z#)tmvd5hfI2_209;AD_;xA@}y**^ssoD zbz51IL7ybc;@~J&QjiJ}VjZy!u2f#?rJrd`V|)z613GH!$W!0oX<@DdFe@u|Z{0^K z&GK--YO3h$(%`5gYd!Ta(u##@4m+2otwD%h$Jr<6gf{m^$d>-gFG2C-92XP z45i8$XMOe>!>!4j`D993BqU1lu$c4sV9X#%aMKzw8dDg{tUBWQ%irO8ugB)r1~OAT z{n%OhcY5p}9I-c@(41MNxIbZOHDUkF1F{$Hb9B=1iAT1$F&a_qyv5p}01dsZRbIV% z4QmY9y**Cu-Q_D^dy~s&QXc!nr!nuo%HRVZ;Gri!%4(j`ztrQk|M{CdQjYk@FaAT` z?X7U^1W&&50)t1_NsBA22=2}V;`sLC03 z`!@4icTiP>22`d{sYIsQ2fZCQBxM6QL4ubq$ujMYhm);BYpgVqHW-K4d@b?aGpTB? zcLgDS7-*b;#GPqc%2p{s#=pDDyfsMeI$U^RG$cVSII88gh9jbp&b@Cp=(zE_u$H8P zUaB~nRZMG3FM8Pv2Ff{4(>Wz*w8jQR);f?5V$N0MCt|R>9fOFk=upk+FW;ep_^{jJ zUFdb<#~gL@!gkRPB$%HL*@VyOY^Mt{`-|T%8nP~d$euEK-938kbCMfBh=qhP=oBxu zl%XnJbTuEsxj+rNE>;n(wOgzXZG8fWpjk+2B_K;-GACAoM&v=ugAyuTEo~%!VPXj> zg5qaveD8~YtTjHLKDaoYz^G_rA*qrmYly6^Z+;^^k_nrB>>I5TL32D~Z7}7&%28T} z@wu)&sRNy*NUae`>ZvrXL)MmVQ$dR?rLiuk8xuayPr@YhdRS!f(lp_bM=mm-*JMht zRQUcP^RhuHNs(!!(ij?wwPmu8e2C$vo&!_U@Anw=GM-51Y#hEr{fB>uJ3gYG&v8vn zJ$Kx9DYph|9B-}R`YY@KBZ9DO2Y%X*>b~0FKJtji12iD64U9v) zSTd-LcAialfjjVb`lst;LKfg-oD4<^Y=4M48nup5J0r^8|d zY9Xi`q>Vu;-^09Zz_ZvdK?MU+dr6a6uok@$=lp_?((F!38rRSp9g}V>VMXG#k+Li- z?htrS608&;6={|uuwLrIS%i~8KHf1bQf7^9J-n#&Sv9^jW^CLAzPfoSPf46(V|l=Q zGG>2wn`T~7tgKS>Lv4VRIFZmS4M_8x!`&ScSF>95IM7SfmwuSb|7a8Sr=O>}af|WM zlzVp%namoVsP;(4`((9Ze}9+x)&=%Ax45B)yl{I$K3n2~)I5|)Hf6(jKIS{~Is4T< z>D?7R`s5X4qM1*|SOha9BO$RUCUwPno^W_`o6;C+XE+g>X;yQ2eVLO)adb4nnS{qS z*U2dv)slw>k_*pV;r=UcF@INb_}ZAI%_W}v*-x>3^$uV9qrc>5AKv5>Kld}d^J|~w z+He0hAN$BvcKbalmytOO&ftWlw3_j>q}SJEsqd35t)nsqhi^)zY3NgN^3HXd{X=@G zM5ltZr;xew&We(h^9H9hquQrzH-NB$ULw18$uS|s;qOaXcWqbki7F<(#Cl;(syfVl ziL)jsI%tGx5IXajU{aix-icn9=r&rvDB{|S=)txs*X{e_S`6zq_ERTHm$xaw?P=Qo z%aDyVG7Z(VLFc;L5Cp`UF_$EWG$p25bpS#vIGZ6krlmRJby_5qI+PNJxM=6P!oz5Y z!gpd3P0;RPGSJ_IxQbkOzkhM}H#)>}figpMpDSADx=mIKW95M!4>X7#t23k5z6kGJ zoRFsiSG12$UE>Imx6b>g6OPJ?$+dTR zr^qb%d=A29# zzI{|uWSS-|*!ip1QF+S9N^*{nZ``8y<~^1+QrS;{)O%q`C?mO;us*2C0;H7Q9RB5vws_ z!|E!*owZ0MQ7y$2*InGS7gA7Vx6!rPQQ|%PQF{VfBN7APF__-1u?6Gg8{Hs;rI%`s z%bKz>6paPhWomlVFCfpcLi%*&@PRS#-R=_qj*YgnXB~ogukDOqDY7M9ymjF^iN!N^ z2qRXsN7NBpYsa#KMN|>@5~6X6&L)H&Fx>~mbGGk!K*s|sBy{7L|13KBoFJ+gr;-qh zn?7xtoeP!2ojRurw39nEZ^7TNSur3La>3gO9>fCra8VF3t_3ASj}1KkD+F2zdP;F@ z8z$D#Sb;PF$wbd4#yG+R64ER2&YbTo*8nP%rc1557>M)o2}%o^S;JsHVNYpfv4T=M z1oFLsY8)u3J*8IHFJm$X>qIN;*qDxncGxy4K+70>?JkxQf@)eat!mOll44QK z1S=$KXEsPVeoHUa8bi~@AKqi8IzmFZw5wjyc@v)EaxqtC*7~Q+e^B?=WoISHe z^ZQ?5CFyhL?ma47ad7u-lBA$a3$}VghIYpIaG!U+_I0kk@dls#xu43Z>&e-vK3%lU@zjP?>ZJBG8wVX4A*60`j6@M zjW%W@L|e}i*^cPo#;@Dfgdo7WRu`}R-V2*mTU>0q@pbCqBKWmk@nSSc&Iwj7!P*1r zNT`0}H-6*4{oDS~M}I^zyFB5&o`DFEQ@}!#dl{f$_wq#>(ZxWz3G3xeXpMo=n(SZ) zSynjbNVP{AO8ZLkSlKFc2&6k7a}Zs?gy41|jALdjGhiqLS>n+^+Z9cS1^plI88($= z;=Fuz0wfZo7Hz=W=dOc@JxGl66~`Ovlu6;Mzg?h@0tYOW@ADvVq)AGVDh5Rw7ICN> zh+1Otaj01lc)9!0ZNaUthRJw5e=oJ}-bX2nmgMOcnKKC5oyLy%1`rm(xgQI)MJA3TyZlf)1uAd=MkX8+YM6rS5 z@Z^AMX_-Xk9Go2R#?4zS_m;@=glhkgVm4*yYHlc=Gu2}pvwf&tg`>DcX790WA&j8dTXoP z8w(ndfdHiyi4r8CEW?18<`I&-so}*hG5YJTlg?+Pg(NK`qDcKcRvMhZ)Rw#Bnrmf4 zgQEwmSh(`=3cY^n<=T}Xbbo45hm#>dVja%-76-zLc0Pvw(YVHh_2#-X^w36nJZiYp z`vq)z5rC)Of19PHX^UVMds&EBlt&jUJhd7Z#TDDR*==@<6ii$P9(@R0?R%XxwWBna zTu9QwOZIq4U0?HIHnwO6Yov)r(Zw1T_lU)PLI@U&$LTSAUu>r}2+;s_#lrFEs?ird z?{9p6w|8~P1Pkabyv~KVM|>O|<(NIHg8Fi-uHXES253UPrJI`uqwWDx@3BA^MKNP3lI zmNqI77r5Q8ISG<-Manc7b zvT2Z7Fc|dFN>Lk7(x-XWjqk!|WH&Y?B%yZEXSTRUQjG5TbLwhm=#glX74IAY`M z7W3VGNK^Lq4#@HWg*NC6)_W;RIfP1aV#x7$%-P{8zx>&s=gi(VzxT&q;t%eh@Yr(7 znR&_j&08en6CPb!BcD0$%y!um4euQ6bI&v=DM*iwdF#cm;pS5s)3BU@?4>-rR4~9X zt{TLoq%b7|kyG}U`3{!D!($%p7d$@b^YM>9!|t{FjF&h0^7WUnWz8FZag#?LKFj)Y zkL>UN1ovc)T3==*8L{%%WzOquYWhsdgnK*JXts~od*?P)1@_i9Pi&o~JUZg5FMW?Y ztG79;61HC%Gu{5bx%{6LJiKz5Te^=?DU)f1a2lO!5-q&Cuk-4~shzWT^#hQjw{_OVyi!f&ei!Y2TdU2Z!igY1fq$_JPkXlpsFo}ael~A7DNadl~7qnrlFVlemHg0Fsls4iB^87%VG-Vt)gjXRo&w#_1j51PE(Wp)CnC&jVeTTV6)jELdM?rijx+Fx*3$)cAw?0Ql@~M)n$ceqFP&ELk6<%twbz<|Tb-?0h z>03j8GG)*gOr~?hd`>!_^H=vLOvZ}bDOQHdq)U#0u#s9;_XfkGUFL^VO5xZaSBO{cvGm11W%(z6iv2TNlxdGtX`B?y zjHfShC6L0Pv84BIQonPHq%q{HIU;q)JRo5$kkfLm5Erk{*N$Vj9KhLvN zF>H+IWgANp;ik2Ilb86ytWb@twIHuy+G9RBW{}`3%oBxZ=148cvw}%u>91^{Qq88_=Jo&epF=sP zKbi5|lg!|dGKV^WT}`r6w(R2dYSWv5vwQtWZX#)S*qeetWPvSG#LJlS93 zV;_H-=~EwNWE1vgJ*HFRv*n!R_Mt^(0<2`GS|=Y2**s%eIe&%f3C-H?@*zkQ!lrA%(`aQLlv=|6duEPH}_bwH9Tq!g63Wm;Qm3Bp;@*@)>&-=N;vLnp%5 ze)J@&$Y`o2NTP$VFq>N@#y)GaJ$f9Uf^2M=S9YWlS6d%^-^tkYtiUB`9l0Sv#_(@hZ5^b(1E1 zFO)#0ioEo}cjG)FvMxwTSo~{*#0ro>5Kk(Boj0hxT?QL{W?4Zw_YI{~n&EJyY3jeH z^-Z+2@J1}Q18VA~r8|tnSEgIVm;Z;1=^k8oTJy<&kdyTUZ@p0S((lZvUV1-Vm^19% zr$S)LIrIt&U6XArF)B+|hLV|SFwQbAYowL*cdygmyTjEle4gozBbuWL<#de5d#scd zPbtg8hqu`s%_(~WR@R2p&d|L43LjhUW2|I6am@Bd+@0QMTWhYo?*i++EtalIn9V81 zC5P|aD$%jWy0q6ZKki> z<@z6egM+t^*t~WZ)^<1)tCVKI+ERhFmTEG`B$8Z8iqU-zUw<7vJ)szQ6=SWEuwhx8 zQ5bwN;J9&2!%R-BW#GJ5-5Q6uVa1i{^|?p)?jt?j1SI>c0=|&ZP+=5Lg)ph zhY0n~ysjZ_9MVme=N}h^iw1@CIWUVu%BJJ*4#Imq0or;IN_lVzV@jWf)6|Z0CO?Ur> zlM7h7X{hZ{TAG|`skcQ^)*;Vm=yVI{};UY0*&EH%b8mw46gzK!fqwR6qp2X2O z$$V**Wd8smRiL{>`yLsKuUZ<4wnb#!Imva7r5HWweTZAf+l)J~QZ_L@&tH^#2fgwpUpPiy4WmQqtCQM|9R0@g4 zG!5h9BZ@3RYmHMWv*Tml`qO2mdy0pj(fs=VwA2<8KK9XsLekFF#H4neX6q zMlwI5H=Ch*eM%{rPN$^FfYO4QPRNdLBER_}w_f@tdpGZMe(fxWvm-Xw&!AaiJxi%} z581nY%)}`SFl~<6+u7#vjR9BI2fX#>Oz6E_He}(b7?qEHT|uc;^!ad>{-Rm z=e|mH?3f;pa4V9dQOVLEB}+A~RK68)bHeOZG*zC$inOPTjcrAI7@E!qVzWiG7+rSSbA3)A4=P&>HjM;XNo*l5XI>gzUfi|R>=ElJY>jbtg819!efBrk% z``U}#ymg;@wdLHIRZ?4#xRmM65oteVboV~Tx?m&}o5Mc)lM&XyndK$ku$IriahFL| z)7KeiWsjA9!Pz3`@({Lkjo7`xy_qH-tYMaynAJ7IqTuzzUHVDJ2VB929$M$Sw{Nrb z$QHeF;-%}CHaJkAOv6j#9oBDMrMP{Cb4w$xJIUG2b>@vF&r^m)kMV3yr39uC^z#&3 zR~QsC-p_2Xcj&Sh8k{ zee*5c{vJspkcmWRDo~f9C9D91FB&|k4Yl(cY8g=Cl?~dB$y$W$>K&X3#d>a0ekXWj zF06;}uQN6vhK{a1c9)sib=EGZQ^o^8r-D!YM>)Uq-%Yr6W1VL{a;saHi=Wpn%dk?V z=;RKZ>-Jjbe6yeERmXIEw@@M%(TnTetEHf{zK%-9zVZDYrBbK57CNA|zQ?^4Ft2?p z;@HMGZXHtkbEev(yRxw~!Le+t#oO9$OflBcnv9md>X6_m>JHZ$qv-g0BNNX@YYe*n zUG7wYZ)cu@!yJsQ#2dmiWO6>JAY zc9NT{j~xu5nm~|k@I_Xk|3|osB5F{ym9Ed@v`c%ooFm5 z3=>K!K`sPSEDeI%Kq5oapLF5NIDxT-B#}5NkhP)OJ)l24V3zejr6HRt)TtoIiwxU% zVM^&7$~k898Oj-it*FZx{WN2BP*9HjLR&if{h>E0VQE7$9~-1PN0L^YOlnG(f=O6k zJwq|tM*hhkFnZ~$y#4mOj2p+9BIk*-Jy_cyFP13pZnJ)Vi{50yy|QLW^(iM)rlSe# z!-CzDF|X_$Vw~Z9Dx*#l)`qK0gk@tj=dm@#Xfol}Sflk4k36!<+M^G1r>s~h3Uee}pNKANC}1L@eKAw~1@oqf)J^Ba8Vqt9~d{w}+A zgKTA;UN2>BkZ^fx!0z#!<7opz`jpTxALgZ@u@3Y)2lb43y29lSU6V1LFhct=OTGJ{cpfGaMzWeqNmUn>VB7Ek9r8 z(`;ekEgoTWY!hMLvp5$KM!Qvp--MmiCrG+>&98QR$1*2d*LW#ntDoFn{c0n0K_!y!T4qH2#wvv2-o?7rvJ%b)TYcZx81Lf`O zL`y%lr*Mk`EQ@+sZsBLJxq%i`LU=hM2gWp5rwP#WZ~b_1g@hBILE$ZHgsL6J=p3Bx zPPIWS;!TJ}Jz>(c6EB>twL$)_S*dZuCEVc@=@de^5R4RfSmJ{pzTK_uGy@jBn@BlH zNuFzx(oi;zeqDRbt$>zVZZwW3k)%Q(tq-JE4sshhzlBMJ6qv^I$x4BfmLyeFqmumi zfRkj1UOUsmVQWmgKm|I@(bMCAF-UKeEf{2&;mO=!(Q6Mo=oV;guR>h5z`TFb(PWX9=V1?Yxv^5 zZPxS>PwORws~8Lhydo6Wmijz$VFTS5b~jdVvkB$VhK+k^vRx&K4YvCroO=wb_*K-M-J|SH8xDG>3<; zFwtISepWl&v_?uvkvgifL8b~7Kw+M0q;i;gh?RYo@;=56sH!=KMxfV*WIy%uh~W~w zLHaOyZ0F63YiF0CJ~ti1;ToVMdGR1va!r7LyaII(kP%4@6o%a z;{PM>&0;Of&ilUKn)cpjxN}Wi-CaGgn=?gG5+zX<9hrm@JBc03wj2k6CB$}sych}m z5(J5nyd^+@00ELXP7KA7;%JC%DjFQk63Ij+sTRj3o9ux-RCV2|x^>4h?Y*Wvd~5G> zilU?@Agdp^`k|}po_o$dd$08k|L_0(zg$~VNa*4qQo&x7Lb71z*drqm~t zM%$8sr?@t9Zx#?KhfwB#X!=@4&O+Pmh2e&A3&Z|WgRY!-41sP3CggC&(gPpX_cwK9 ze3!5jArI)$Xeg&_u9Ss+HOv`O(g^HoTO7gKk#!-7EmAT{I%S#S2!&t}g{3wOgj)OO z!DjWSR3CIo#<6j)%Gp}~-umA*Tbz4^jS)PQQJMgN&eVB<1^3x9!b}{=U~G1sYtaPtu&`?$8-_7K(kuR zIbXF@F`;kYV>BJ{`bFR{8}`i>?;Tx18PBtg;j25lOb+&W|K1Ld>&*FAzsM`keUYy( zBdsw!c6E<;f6x0_+&<;#&V5$P#MAG5g7%>$$1l7}TzOvly)U!>#6xJ+@x=XeQh@EW zhTdU+G2wVWj_brY2!`-n=3lmd`YDU!7~ zE2Axatn_A=*wJ3!st@Ff=9=p1xDQ&(3idgzM&qo;8L6izB^gWaBm_CxKur32 z&qg*!&O@Kt+A**1MgN)o=k`IcI9~aQDM4u8YLj9nS}p3_IkV_GVhH4vdH3H~^1d6p z-@+68lUr}yL_$?2;wh0NksB#SzaLrK7nX(EX8u6dEK&>`S;_<13P8{9l1G-wtm+Z1 zQn(CC3#&zKI1c%(5(!ur)+g!|QJ6xBv@h)E*U3LgW>x8#@@ZB4j1 zy^nKHWkanj#{5C(>YJ_5Ey>ZK>j~!Y7Wrp?nirq@5_{X*TxZEddq$&%Gw(PvTRi&i z_j2#qFEOzOUpG85+9Isx1ZVm5(Ot&X9`70*a4|dPW}W%`<*S^HYJT9cEBtGANqp|} zJb(9;tPLYK;sc|a8;@P5dGcY-q9#-q>;U^!O?~T-YwvlIXCAx6>ZLb`)0&&hj#npB z)Y(1U*&IyfZI`a{xBtBZ&UYT?XaDP8AS_y5dG(OTKK%V`9lg%!?Cr#=7KPl#;&flb zRp?5L&7un^Q)5gZg-Gio^G;Du4AvUvZ6qeBt)bSE1?D6;c5M{Z$lyNzJc}=XnTd*M z=fudGqC21!*%|3+SbDUxoUbBnF|Oo{Nl<5ro{Pv2Dr+&QF`~6DdsxIlRW6;}1*Xbn zze*-j)OoepDERWg{{JJFlGlpS>;t^s9By=}_mEZp8M=H%EEUHABVO0^dRACpBgq9; zP{?eZ+G=Jo(uFKD-lq*zjl^{Yf(k`xSoQA*Qcuh>D`(mIKL875GPV#CLd>ju92`ky zr2)6^gY3_LpCwo$8AD9D40kMZgb>Em+RtqEYdqLI-Agd3;w-d!P`bpbjH?{Es5|GF zpsw&nOVIHR_1-_t_0}~KYGIcQwjUr%PpxR##L^(O7F|@V3x9v`mVJY`+XjPSI7A78 zu|($xUBni+DJ39KBEdp)Ebr4Zt8!*g4$UAB&1hU@Xsl)xG7}$hm6FEMf>#dH)3nBz zL>YNQtH5QU<(rsDKBAPy6n!k!%SY>kb{f|y($Nvk-X-FAQVxk+pHYgOzz5H?GA!E6 zyvvNoBW5Q8o2|M?aOs=ew{O0jPK=CUIlG|!xu4NZ!x9Gex!IL?=uS!z(i&-%opR1^?P@ZvFCa&>kLeWbRU+S(p;7hN+|;KwNc++@%FU;S0==`r<| zCF_hHxuJ$-tQ|50S6jSKoUJ+*Szx6)!vNYkUaYv3q&P&M5}jYePCd*8^8I>^*4~K@5L?bv&WhZST00Yf*~NmosZqud zVuTn;DN#9xbCwvsmHhEfcD;3tgr|n>8wCR`cw|xvoxwVY8&k{r0Z0=46vN6!q*K;6 zN)vn|Z%b=URE{ti6Otc_?W7D{#wsbUk=F0tr`+0>Sp=cTwdagV3GEEy+HgAebX~xW zlRykH%K_;}WE#PoZISqH6|^Y22$e;so<=&2Q;5Rl(@HeCQp8o7#r+E=SMIUcIw0!0 zWN%3(H>QjY9acxIf`x~%%T#qk4js-F_~V;Eecx=g$*`Es*#FJnq`UPR@3^tUB(2bS zL|PeQSQ2)(7+-so@pPNp&%H!*a2a)a&Z=v%X~|db-s9-8h^(dof9%uE;hp4~rquidieByUL$?yI4r?_6#yz|e0n5!T9 z0eJXH4r6BI9L@JVi4LCJd3K+91M|gaIjkza^!%3?ZzsCXp7NA6{JVeg5ssR7@_+ol zU*`+I`$hiT4}UjX&wq-&?Wb9d-p+ZPuxPgMaL=&bStzXg{~a_V!>G(@MK)cJZwme zjHYhNOc45A8}5TPHOBYYA$^vWRQ5Di%&qJ&yQQ_*E;OMr*UI3qJe z`r`N|L#eWTW3ejKUX9V3&KtVU%QQ}qGpCJci1iFGYnW6HXZ407k@p?yB^qj@rACo5 zA>_f4$XAy0*Ton(zJ3i`21JCE*h|OBY&RE}lB|833hFta{#iNy|4YSY-`*GwQ+qk(@R2tvwpu zq1=esD&c(~rHBPwO4#J7NjN}f(WuH9l(CRS3MCh4E9Xp88_Y7W>Jm-cVa837#+Eta zC}DCXEnVrRgQ#GIMC+pf#s`ecLlo9eO%&>&##9E|CAyop8ShGgAIE;>3tZi=*tQW`O&dC__AG6~ z$zn`y6c@KoIlh0!*3(a+Lr1=deE!xwX4-MhI;tx3Vr9Ad$UZ-Ke8^L0OHM8pyxw_K zRWZKO@b>S2iuBG8^4g8}^Of7Dy!a3QG0Wh2__0U$D?j#^nND`uedr;)Hmur!S_bBA z$I?fZUCY9IX6=ajnGaDt^bF=*@8UDR{40Fm?FZbxb%fg8;rb(cyz_mJabYdT_wUl2 z-X%SK6}KB{bmYt{mH}$lQ#d6CScXIL)IdPUc^xoM#-?N4k>)wW>n_gNFRt%8dD5>Pc$i)FxV1R9F5jcYlE|f z$|X8$SQRG{Q!I!@9(rb)%27Fu+sLv~l6?@8Xw8|8VOmCMtPyxK#e^~PbFB^0m(Phw z>QKeu_5=h$Kt%c|#E5a093so*imD8g%ca}7>pai?M8#LCZ_`G?;m;*DQKo;`=5L+7}2VlF?W%xT{x+B`}I$yg&{*6iNBg zKcbBWEQw5A8|D`)nmad9^%mYv=-L&8z~W+#HJWa$iDbr&Bga6@U`Auw(4p*`PjwIO z-)HpIuW)%3*&b8$a{`{3|aJMjmzW-6-~OI-{~? zp- zrY?ebMf)fTMCyHJ3BnLWjPM8;HKwSrg0_~>b*Kk6_oy~b)At?>?Rju zP98=hthz|kjPV(2XA5lI*D55_=>-pa$V#rKSEgRqSSzb>rlP4Goe%gB<@M#-thJ0A zSE#*x?Iah$#xVF^VNZ%POFfF1#K;SKO5-ZWWZcj+6>ZzGYCYCED(8Si@Sfm54He1o7TusiJ6auPlKyBf7_Q<})&t{y@&Y0wmaZ1!aP#JMY z+7!Y$QYdd4%e)P&e4^?+s;<{fg+(Y)S&h|+QGtXbnH7pv1{*SU>rtb+V99xCWK;#p zGIhpuk>%li%=jkh;BiujtmaE{mTuaJVs?7Uwd>bNe#v6xu}YDvingT7Z)RP6`3pRL zkl1QQbZtlUiRtw#pbW?NE@&5;G`mk8SKPXJ$d#ua!5!Y^`W_0wPpOw4g7nb;nn})f8~kpj60wCEK~h1e&9Q9 z@N2If@wqR2jSpVk#os>T4lAx+TQQFnIXkoxu6<=B8tlalLg|t=Rx!4kWfu$FCDFY$ z8ml!;cfqS4`$g>OeVVNbJyxj3ijj;FV=bu*570Gp$jp|3N5W$_1an*lt5yVg|v*1?_rv4e5bfLn^BEM*xHFSL+1(JQ;oLB?U`&y zSD{pT(+=d3QDmpKtj=cG?GcsQCS5t8dh`kG@4Y~M))H2c_LbXosl~09Ja>4PSqoS8 zHJ4-J+Gxb_Y|hbgMw?rvx?^#sF!Pp&e&GF7k3Y=#ul;Q`XEAOg9aw(icewxT=h?RkT`TmYLN``w0$QNWUKzJ%BIS@cU38>^_uDim zlTg(b=aE?#&HICv zH~O>sVr6f)wH_K9wUXKEB$;C)H4!z)7p;jW>kO)gz%t;INR3#X(326_+CkGQ=PZy= zmc0^_blY1aw0fa8i-S!i@H5KbNe?m;^SWcbsZ1F}M;RHN2~omZA-u>n_QZH$O_dsk z7Wf;b&?%vHO-_yw{7^e<+fE>REo`dX-`}BDSx5xRl>ZBfXw`b8=F&r#?#(^Be+BC; zYa~2wgK(<)LDV z$O{a=C*Us8YSh*)ak@>Mo#T)1FkQ}=Abeb{nqD_g=d5ksq5M+$6 zwsg58#XvI}u{q4=k6PO!!}k@vlu)eA2Zzj~9a*Bt86_j1SGARC9vl&)>r zA0bPIlv4mi8s8{!ER|6-!07BgFa7ghV!Sw~*|+FgqiZKaz+yyMLzpim_{e#v0fvw{ z@}jw_vM37JBqNbsqlMD$Y!US=1IcVDj^~WBR*Yj`yv=Etm9wVa_M04X7s;h}8u253pukQ(rE?Svh%jb zs3#NhGST@pVCwOYSG$sz0OA*i*|Xun|;8@(H< z_v%GgKPBAuKKJe&GCr{2Mo9X*A(K51E82ShuMh#wSL=QsS_oFC;{8A(B=dW?Yv-nH)S_ux6zqRi)_W5sr>< zb%gB5Ib%qKwq?4th1QPaqZ6h(TPzm~a@Ucq{sSGmf7r^GuVJ40E=HHPdE<%i6Gi&cCZE( zofx8&6DsRrkJVqvahw^q3_*b%UelUqmkt;RvSn4y(r%{=M6z zJ&PJu1#T^B$0gE91=fl&VM}C~LqgMW_ZNSelP^EV)jdr$(de-O2bm<RTJciD|y)Kgc}3`__O-ZyAI&KvzRCPS%i!ry+kW(&xEg#eKRgS;9cwE%VX` zSS**QYf#kP@IR_R4#uLIEiUfeXMFkU(4{?08`FKkv0STC1Y41>J;FsZW_9n7t!~LU zN18IL+FHTGyVeVC4Mq6QKu&1q(AG0D8WR$+Tz?1BVH+VXSLoW7>|=d%`g!rj8EThU z-kY&=t>V7gmMBJpscT|POq+%~hj-b(w1+YpTh-Eu{3ao+mp|}f=9evADdu*<)OfZ( z_enSo%w9QSR-f?jmd3P8K6~>Xql2qBpEyupPfiF`&Abh~a5`hl!0NDLh2e=G`X1c% zYp4%?nAl9E))BMNPJzxx+RhhPLX1`C{a_%w5IH+J;mXLNEj;?jRhmkg&MM=m#|9rF z%LvXC-6NpQnr`=i>5u<7pZ{kcqIvxlUjLyh52Q8EVN^w32JnN)uu#O@h6{l?--mA4->cOd@eo=)bPO zl|B>^O&{?w4uL~&Tn4yl!+~fmMfyGy(WO2#Fy>0lMUk;qV@x9~E2B|3Lg%GU)Zena zuHh)8wxW&37-CBwryqUB(eJsnvSsfu@&m6Cry;kuALi26 zQF=&g2o5$<<6amsC8(#{bgLDM(__ZF`}FK8=@CijVlaA4O({qi;?^E*jI8b+vK=$~ zQPS1QYL+3=wUH)g`q>CdmxrtsZd5bw5>-enl{6t4V3A=I1P)894&Bsca~6%R;uN*f z)V0RXBWgBhe|yAn@Gu&Yjb*W1Fv%J1YC@7ov)}|CL|lYoC9f*Z%2E-g)SF`XfJxyZuEj|66~RTfhGb zTc3NDw7W}p`Kn|Y!ye1jT4Tw0o#}kQD8;y4a`yATfO`FPcK0=UWYCqBo&qh7BIit4 zw9s{+!RVUYCYGlQ?p-XIr$|yVg|JHCQf5+H!SV}nqco@&g9yDCyhO0Q{!`y$MJc{Z zHm0=HAyiJ%+teHT_~y^8IFHipUg{h@?RMyBFOvpy+N`^+;jfhXVXfjcf^lS9(dvo? zj#Q5cqYA9IJq@!w z*9Rzrd1HPE8)Vy(Gg*_#5Q9oV!=>w>kIlleK*BG=vuO^@w=CZCr7v( znJR-Z7NsH~WWvhhrZqXO;j^4UIYaFXqc*aVWC#m*1tBSHgs^CZ+Gox1-PU4~61`R~ zGe2LkKb|qyBNAiUuA{DMmTgDX)GU3V>tx`Ss~m66eL!st$t1SwipQtt-2I7P#GNLx zZ3w4_Tp4Rl&sz?5ud_Uz6Jnr=9;ZE+j#n4=dE&;CTt2u$?G(;lLr*f#{qui;{#*Yk zdO9swZlPW(&B{wr*=U2-iONa3?nAL|T9MinRSLX*Z^e}-FR?Qn(bSH{iXK#mxj1=6 z@UaBCxjcV~Dh*J*|2w$;&Uf+9#TmI>a_hH#lat?kmiIi-Fg5O z?xJIH9ykrT6vi_yLzAJ(Fl`LRl^`n#y*srYv=PRl(lSgciW+l_vA|a);3^~zoqN(s zhMdS&uWNsA7TfGkmoAW%Rs&UiP@>LR2m<8(z|tSyTr!WW3`rY;u2@nr*EOM;5U1NP zosf-{V6H^%8OX&k%*X_Ffe8z0JI0qXwhz+1ALAMdO8uGXZANiw7;7z2?vSmpzql{l!a?K>xo!i|9v8>Y+p~MX|na(Pt&{ z?|FCwg+xOA14(70KQK)#E2ft(<1c2=BotPn4R~<#0VzfZf!uj=N+e?m`})&C7k;0MPk)6jkMVCDa>FI^ zdB?@}HcfJ%GAXWbi1^^iB6HX-;I-G;eR79aUO6T%1Mm3g2Wj>$adGVi5xpMb6Ei-G zAv7AIN;2V5MR72NJ*F}&?;P^Ni!X8gsi(Mpd7G;{6$YrSsCKN1L+U~lO)DjT4`qMo zvfXloP*>RIGR|6_{#$P&e(ia>SAL%~xlF4Z`Gense*R1HXnT(3e z_VFF={F9$%G(Tp1#i5;%j45TTEBh%xT(lT6*(jN5zGzupwA?>ivIycF6d9XE>ZV39 zau#JEWnu3K99s5LiSVV=UW|7VxeLe`XGMzMC+P#x3XF*JX>A6E)7m`!F-x(wl&meA z>NAp*hWR<=bPmOhUi>jCi`Nw^jT+Jx)ZfB(e)oH6R# zu#vErVe6Z70AZJ~;RO2Esv>R7IvXijGNs@l_+x(Hm*lTT8sSi&2D&3+mDhZTgHRrRI-T67ETVpP~C40|!)X=V4+EvGR zYYS~O@muHvIXIXyy*%RT{1z|%i{D{VPsoeN&ZQ~!V#b|&9zV)VOhl(dGhbpSBbM24 zqAibBn#cDHx1T?x>JnG>47*S4a`U105+~b)T%_!gSt+hSizzGG&I{ge4Y7+wk1U|( z7aYFuBDr0lLQ4)FA8V1eKnm_!!Lp0QBo2z42!iI|j7WN$f`j+5qz{Rp5w_9hDr06asNE6CS%Zl6F=?xiw8i9yKyI;NCq{Clc?e^TJG_Tv-2& z6jZfg;sv9RO4F5Eh|dZeGbrhf7qP7M7teq)7M%jdByv#9?_F?xdy5xCL+2w~(-G6H z2}k#iP}z_|q%!K8-}G;?qN!1)|i)1=CrwDvh)Pol2gk; zow?|i*zJAx!-9joF*{c3HIpsP-eU*6^y%kF|IuHeb0eWLraVZX=Oh`%s_llTF+~_P zj+CM4GP9#ICZn2pZ0RugqzEyffm!H}qhc8{=S$Hwn%0`_k);|A^g1$@Jt7!-L@3qm z&L!?31}Kq8Su&vzBem01M#*?$fEd|Qk;Sk4-^_pQH`#ZAYP+G@8CldCDC1cvvn~|hngh{ml%Uj9`ogsC#YcOVQa{npIHIeWsfKpEgWuZ0H&ZFT zZ^91i6H+co;0LWlem<4nsFgC<;FvGwFm6CgmY4cYKSdEelzA>q<#5(W(_ne_A!U3> zB1clPqe0?5BTTAdQxbguC)X*Xa3veaS)^4$Omra(a9B`^5L2mFD2zcw7zg4{@7&Y_ zwc0+g(Isf^Z;jYQxrROm`Bom=zl!zNkF-S%c%U@;Y@~PnYc}d6^1zC6)({L7n5q0? zFSXn^-VBjMUS}_BUoOm%zMllv+FZkhln6+rL{1T{4591LC_+xy$`KHDNV;?h7E5f1 zgk?+UBBmC7qP!6m0ocki(Vk@#x~50;e&#t-MJ1zYR~@#JiEDk-CwRIT32ns4R z>T-c6wJ@>BS*ERN2S$pSZ5L6e_qhAYYutI`kf;rl<(zi8ByKg*(I3EvKpWB!P3}%A z#eBPfVJ|SOu5G?K^AIfHLmF{mgqKs?`T`iVwG5=Osi!St5XV>B~rDjFq=@N zzE=7yGy|+B{S}a7Bo`sh9Lt#8+@F_H!;1l6er z^Hm7FSLzn)49%1=iM>AFdg8SnzH5Kydh@WplX=4otpnjcb9o@*eGArG*GRZ3otF=K ziU&Pv?|C;f1Q>AJ-aGda)tj?A2E4GOd%f`D=0^^jbtty2tMLj-M`%eHb0mAIdxVq* z+)@=vj4ml=w3c*mfQ=oo?dZCUD^k%?gji#s#u_TC8O10y0i_9uwo;qGM1}G}k|?*{iQH zo6T7*R&4L>;@@}$W;clYQoQh@MNwVc<}3g3f2V%&6}Gkw)!rDK-PmhVUsFl?ShO~z z=rLqgvpLQ=!aT4HnNuZl<9*cY5YfP>@{nOqH+!5n3r! zghY_h%s!&(YV80*gbM8C16;{(-y3MH=1BA9d^nG-mDf2Z_?=UtELk4Atw!tqKR5=Pu$r+rnGLE?1 zhaQRO&w^4#2s2B@DJ&=kVdDN$V#=bdOsSm}#G{KzAkU(OwMH+b56v1)<19@rFs11! z&zJ#X?PHi!Y|8@^4D;GV4H+!!M(EAEAjxIs;0Z;u9?;Y&;X>~D^J)DQ^4iU;i%`QuDX;6ZmW|9{@H1H=is(J5>+tQWL|mY) z6;8HZOGnGKE6mO=?R&7_MdYY5U8#sx)(*NyDJ3x;q4XA&=3SOi=Kug807*naRK!r`E+`aZzu^AQ{a-9T z{V8@_OLJ`(tO(vIXXv@M$@dOPpq>~aAkL&+W!hG8r}ex+WUew5PywT)SSk@#Od6>( zl)6HS(o|-gBj%12g3KSuGGQ~9fF^6n0Q$jX$$J6q%N_=WsVZ_8n79Rx=1=fy`)Bz- z|FaoC`d>}ixhj1~pZ(>Q&-{Fgv5EJ5=Pfxog;6Ehkm?W1kohNV2-TGNWRK;+6*@O6 z#yOW~u|CUU1B%Kpy|P4Kt5kzw9U6QQ#+@<_S5;_)31^iqWRVA>(2!CYG$mO~=OZab zCgVmJSUC?iCuf1S21u}6vM;rbdFv$;O7c@_@a;1V2?(3YQW;$`jo!wHg9)X-NxsSk zbj8|v<>AWzaEK~z{NY3YA?#P*W{rfsHT(l&h#Q-11NL7#n7qy$`qUiy<|_uMr#~RQ zzW$n@k%xyTKarOgSoy@NZypli?Y zK4N_=ow=c7RFQaP~yoaew+MT zud`)p=Ix5{?Kil4a!TbUr1K7vBBY2MX0&421==JIHRenR38xb#Cl;$nn*+NnxP5lP?C1`*UD50wFxeV$F`sdE z|ANCiXZTTOx;4Q$$F8+(HI}BbL$(;B7$!19R4T>qR;+&Q7kT5K{yYbM#^l-vT`7h(*sRDw_LtIGVj2`Vc<>$3d$cihrych$0=Io+ zri9mDE18y=%GR_fw6oaCqE&GMCF{sQY9l?$Q(B~~diqEY6WF$#f+Vw74{&KYM- zq1;ktf25%+Jx0;VO68oJ4RQ;rz=mq=Pqk@_3-z-xPlQF=4V zfBhQZ9SKzie7N6$>!_rt=x%IC`PFr^UMkF)uxbfyH$3Qsz)rxRkej+lwwk0g*%(3_ zh{2<6h2GwV#R4D0z{XNaa^+me-8w5qwIjr?Xz*0BNi!@`fC!VUNU1A&M}}Aun2|Bm zPLZOfEi)uy3~+YJW4o6)^hJ8yTCy?Hsje;G`*$)|-=X;A|0J1*eE-aqAN0KIuO2h| z?|+?3+nUvhX5T5o8#g(aOxadb()ofg88gq3Eu*;9XvR5mzfoM)TWnq5@X1E)@7c1BPAQvdC}|Bm3Qbf|+n9g0_y6s=-~>)bkY&zpLTs z);$hy-(mmi0kdWYy-G}~Na#8yjivRu6gU$xCw$0sL7EChDqMO6`fh54V9`!%Dh*m^ zTyY|~Ft~CSSqrbhr4IG+U+4D!_LJ-!-C_5#qiHO*Op?RO^Ho|X=P4(Yb)=;i>GYg& zbxk*m9GwRaFFNkzM9^jKH&Q@vfy)}|0CrMAC50N5MKF*-e6Q5{axQZ-`fR$V`)YCy zq!`f7kvd<7l^K*VPx$ciukmd6A9J+(Biw#L`fo;)jvxH!^StXj?ojx| z57@3;lz%arq$^gFJ@(+D2dF8IYI~)#?E`S=-FFdc9?hgr{eUoyQr9 z*Xu%>+|{hsnpUv!2gPt;`Uzi>bgXM2;vD3h*b*i9luMzjd{}viDW$@~9RxH|p(Tc_@d$zDTMJEBV1s)CqEh)z-R9#kgzD3a<~_Fp@ToZMZ}dBs^yoU6=2%VBI# z=mbj^cY$_$^(>bg$(uAo+2yvJXl*Hls;7Ku3RTajRCeV^* zD80@Ea^CDap=1|DM!r~jYc$Rp5joVt^ioJ4Qs^P^a%Uye6$jbRa}i1UZz$Xk8OnO~ z_AkSx#^T_F`=@vGQYKX2c8!FJ5B>c#WFmQ^nQ+azVtt=B?ng8O@u0WN5%4JqZ zh~zRoZ*|e(yUa-l+*aTVl{G0T+(rcrnks|MVsLsHjeeRRoiyypz^EYo3Dy!9oj_=% z@|(+04P}g2eQku0kqe{-!m4uM=Sx!Cky6CywJ8($OO-z(Mwbow2d&A~nAQGOPNtV= zwUaC;=K&^4?`=9@R{|i+5+pv-F!Szj&vT{>Z-fWyvg99F-8N>*T zoWUw7kai)lYCDWE_?UrMW(P#FgGpnGA%~Th@w7ffX7eRoC&OK|v!o~rw@Mcrw+yw< zQ5xK0fu^jH86KVYXjd`X(%8B|?;l`JjtPr7wm?&8P^pNZN%aloG)^hDfi4PkwNP4M zvY2HGTZXNesZi(?WyW)i)EZWRm+*(Miqd_5dcmd93HRm=-DsO`psLy;JF#x6R5`Qy z)F-+A{--(p(w8~Bb;{QdZ&T;Yc)G>;JOF`|JiA(v+Zp%j5wY4PuU0&>+W^ZduyI61*6uWPG8{O%B zLQZ`B%P+FCJHbx3h(6*YO!oHa;*x6jfO>C_qq7SpaSRHUZ6w9O_V$RBWFVDRu+=!W z8$)eG#a0=GHCDcVkft)95=xQ>tj^R5rvE>AZ`NyDmgRT-X0w{zpZ0dqM@BZ)C3Zo{ zw!p&jn@`y1UO>bIm!%fBc(QAM@-V{r6n_(Vy^66*)YbQcMdV zB018Q1h&#gTSC$TAtgYA#UvQQre|~4)A!J}kqe2mk}G=2dK474bjDD4s83YS&jkf&8Ml5<`MPS=@Y`0rt zh=dTdN(hnAwmNjnm5Xzhko|N*+hI_3D*{d5f%8;TPd%+QjqLCUvzXIwc9co;1|(YT zSU?A~CUg5;!r>?ltPlu+Ml8-cBt<&l24O0~1cQ%itY^GoW-U>KCgyfJBus+hcFn@p zT$NL0@?^%09Xb2@l9VW)Kc)QOEzZ6;jT@c!#l%N45bm)m8E>L zq?9+DJe*Sh(zj`UdP}OIvxah2arkRr}=sqUo8J#}`=~!s_Vdz`k)h=Erlcx`+J+npV^C*+VOY+f!^pd3 zKCp(tb-KSXTT9^!Y*En#!CS$(+^qp^it3>zN#Q211>=71p(5nc@2y5s+;8WS-}BHZ z43JimymnB5r@$CqmF~UQp~D%dyn~2(AiWZRf&Q^vG4@f)a-mz=`!ZSNuEBW%r z|1w`+DGN*PFG{rC&h?wN%`(<6f8nIohg48Vs`4rrYTA~r*PB@up1$j7x(@FPolkgA zRj9xy#Kg^}(Mkwaq=v4i??Qgil#PIWmkMW(A2-dR2L^7pH+RiyBi!g{LG z@83_p)jGQvIGma|*vE_z3|DJ_sAMlP9xPM*y_8CI36R`*42MVdG_wPvYp+H5lCX2! z{q{e9@BkZXJZtXlm4Bh>_^O+buS`gIu?u?^-*~cSpfh(N!yIH7c8xE|vy42WC=0!r z)4F0dF?1oa-8SsDJA7HGoq+dLrK9qW5F?viN8k5(h^{P+uIoly1?9PG>+6aF6A~$A z6Gar`jD4V*PXYFeHd6^P;EW?#OIjY{mUH4or-zR5<6W05F4RNBqN(O;M(3?%Ss1SS z9*?qWT2aB_twe%A7llcL+JlKn9akMRn?A#N0khe0w76!IW;DLSIGfeq`vW9x?wB6V zdG#khW_x+XfvI?Oc#3IyHf@6qJ=3JN^ZcFlgE#F?_1xZi*WP&3%0LbbKX4TYarM9b20!@Cf66;)%gM|zUuy7J>N|`xPy>ilE-5jc&UNmIZV_ElOA&y=IVPnWA+o_^3Nm{?|GiH`^0dtz#sC)WI}n$D zzabxe*vO4BG5KZKe8 zITI3o|6+%>tm)p^Xuqh2s%7sRWAecPNTl*=xhw*GuMdvTYVEe^*lc!s;&(kbhZAL7 zbpdv}hQ8~^h|P%5HXWp#yH~&vw!gUzN(Y7g28_z*m(9PDR0{1Obhi z6`}Dp_2B{G>Y5@&W$Fx-Nd^s4Qa-<~kv#zFj4(4!AIubq)+1N~!Yzpk6l;%UeFfM^ zrWso{mmBJ;!;qMjHBEI$D-*mm8CKBiYm0*0KmP+Z7q^JBJUBjJT9vd-;AXesz$gh} zX?ENM1FIGBZq4HwPUa=`;fk}XEzTu^uX*ue%{y;>1AjE5e)oN*vkLJFpTwAO%Nd|m z=&UNS+5L34*>X}PZm%v$n;qrsfCK3;t0f0V?{ivJv`Kh#wV`Pmq;IKBc}_oC;R}QGfsiyKhOW=L4oFVJlT66OcblzyjNV&| zAhFYfO$@HiBoIkT!ocP(-jXEHZaTVF#V>nX5?v!Bp|EbA`uiqj*%Er?sRmcv_@6<-f5cP&_Q_T^gvBI_Y7I9;arAv zL(~k7yrE0}Sz`7qu)VcH{ltjr=~c_`B>{iq9~d6gKW9QhEh6?>6cQfa0UQ7|d(|bxquDFq!RT^Zdn{!FAa2|k22qzS3ZjAb zyyfK=xBT?tjyJ8aF^1PfZY?+rQ-KxQZ7ic@CWe(OSWPD!A555?*7$=0iiGJS(h4NK z4q{Xbq#K&Tq(Kx4m6UK+p-~xB;kkRkJ9XeiD|}aZhQvpb;Cw;oc5Gt~<+|U3jAe8J zZ%Orx&GM96SCfn#pG|$P@7W5Op|V!%81D!A?0yfBB!n2o$ksTh+eJt429u+!2P4#h z?(6W*j8^P12~E?fWlW~=wtXOp&Or-j@S>v8u{$7T7VCXYE+3$*9-RmnmK!)|H_~OuI z>=&TP)e*99-wGgfJ#F7BbH-S_5sJd&tYg=-G)+5J)|%p`a8cif(IHesvi(EUHZ>+B z=)!YlF*2=`g%wG?3bBl}*#=v^jf}OrsBIQz3EAM#W@`>|RI6d@Crno>`t253)8+RV>TM_DK_ltI};0UzI;@vTws7lzyz@#kLOlkySURM-OE9>iziPFWNjzx_7#YDryJ zglvS@gv6|{OuWUWK=`xYeYh^4*|pp&UwPtaQS-8 zPoG`!a@%t!hBFhmbgB=ijHOPIlVmu>u@u8W;aN?l933uLEDHR>lS;5&AVyNtkwOBA z7;Es;Qd>rok7UdNO6YTw;w^g?SSCKG3y2U8ihGU+CwY%>{_HIO8?9V?;CtJDoKC zn!~}D#Iv7ys<3bPs3rWFS$Ru+usmL37dmE`=A5Cvh?hl7HiZ}z3l@{+YwV1 zi&^~+lkE#qjAI&^EH_VMg4&TPebbs-0ueg4F&9ludF(jtGV7=?`cnS>L z(6H?t$Ax1nj$2x4N%-52iSxYJHJm14=D-&YJFmEWvF7Y+k8nlF>8fTi6>c^?H+Ng^ zc0*LBAw))4Vm2wUCMmRFtX8H;=)GlDdkSY+P0O)L>!S`+Q_>-BT^V*wM^$>2nD2)*Q{15rl|Lh-PfAm8h(X*Tsgd|uu*q$3C zCf&f=KIc=w)%AuiUf=QQZO3&IZb)2Nofj3N9#=;qoF>a7DL5!frW41*2MgxQ3C0Q{ znrz~dCAEPV0?v_jC0gmHJ}MozE^vi93=mP@E~5~QI`bw{ib{#KZa6Yjt&Pr0j8Xb> z0!$QkO`wQ|$uwhR_u(i(^I4WhTo-eKEf{TO1qQ>?p)w|Kc+M!HWrU*1`i!Ldj1&`X zv*Y~5Q$l{Wm(3A<*Hca=)YCbkYq-8RBXm91T27z5#iMuLRm7q1X`5bE=0IJRIVarG zZ`Xvbr7TM(M@NLNRlAd3zt%X*WHuW$VFRmaWPT2vMLzHnj5+I?nyF3M05t856Ne{Q zMp!Q+WczMqoOv+rEzXQ}qy9YhI+#I$pYGq6{Lfr`3hC!jNccDZLoy>H@7dNMS@R*r zsP`1Qxmbjz?{U^qls@~>=pqPF+t(BmhU`W-+zHW2PC}nOth_p=igq5pEWj9iQH-rK z#*m^Rg+Pj0shCU|G5hx0MF0RG07*naR4Ecg=$n>eRpnMT?(Lg%c`;NGg&$%sEn#)a zWbu^d>V|op4;cZ8!w@d#59Go6{l#MQKyJ`<%}s{0tO_A})bGh=d5IOF?Gwhq^`_G- zkkb`m*Wj)$SU5`+-vX2b(5=_}?Cdo+p`~^e%T74&E;*{EU||*=EAME5TW6_l&k@4= zs~J~fC@*@ZR*fB#^}K$yMSRKG#hTs42GhX7V#>j+z?j7KT|951FUPnJ{@!MK1(qmYer7$gh)5=H5BDO*S1 z_o@Z428##hkwS}?)V8Dm)_K(mPK=T@Fi>QntTTF`SgU4_(TpEAy=bUaRH(h07GJ7t zC5z%@GUsl3#MTsQ$Ic$Al7VImBi-HRKkx5(DJ9io#Yo7rOJf}&1lp#-7{mJJhKKKd zz-)CeuKS`W`QnqGATja$^UpXqIUyNO)Al(i4XV0Q_$qhSySp`SogF@Th%S_0dxbu$5bfU`Kydj0I*Lj9D>Qs7=3bG1o#CjmF*dLg8TB3V6%y*$s8&F@2=m ztSPq_3^GcPc=*8suAg5~Swm$l zu_(CN^&AIy>u>xLn~A}co>-MMA&`t#iASpfNs(#gnOB}o*VFfER@tY-#5xv}B6lZ# zg!YueZKw;)NO8_kI)g)pnikDbiDGdsKlGw$afq&q!dhxy;vJ;WvDw^GfB(Duvr99vEK0fuH*Awcq*FZ5sf7%CzcY!kr*CQ@X(e# zDhf^}1qX*y%9$hC4p70Tq?BWpO^%`ktWn*Eb6_H6>Gc4!DsHvb;))_C9wrs^iD0}@ zS}_K!AbFEU$XOwRh{YH;8gMF0$gpmDj2NnEm4^ZOIgE+q3cA$^HfgY>R?B3VTSjVGxKVW`%bkANym>(QamL<(j=aJXfxA=NC z!cHzbW2dwqHoKyv?|WQP5|dDsB_|Iba(sHi*~?cvefpG7e)1DO{Q5^6936sj*>qDk z>_HG1qNbJ(UVTGARE&dvmLaBuiIR~G!}e~?v!8v&N5A|_SXW@s*#NdcNxw_VaG}pL zwBctBL;L~X8W2RSXZJMT@&EG|-6M8=C9khEk+5=>CMC9QuM7pANZpQprY13P1g)(}ZJBa~t|!0}idZx=O>>WT-`f@$sW z6+oBc%J&fFaR_AMX9j1%Q#45_Hzp&bkm?1x;CiNXD z2b0AVadkaDI}&uZ5+ZE6K!H$CiZ4B@5kp)Ya64Vm8g(%kkb)6}F?)kSpSut3r1j63 z_6#Wz88d#yPA3;Zv-yJ6@$tAz2to{zZr5O~k^p>J;))Uj#CAvMJ8W69ZMPWfD60w) zWn$?;qKHEm)FicQc9fF|?|<+CKl|hpe)^*y@!>bV!Sd)B5!h|+&;ulmYJFeTG}{fa z@0iZ!DjG(Z)Dsn;rbxTn;;g4$%*Vnur9`{E!8wOT*lad{VRd*wRZm9h@{ohBhizt{ z{RKE}n5u~Euh)I3|EqX?Wd}%1iOsIX7>h|!XB)kGOHqkmZVQ*YdR*2C}JPl020gAD1^sw4fP-XOligB;6xc@T7azB}Gb#%nAiE8oK z)3*)Vs|)(Bqo^tlP9I{eqr1E2?)nm66u9|<(C)asxxrY+>7z$fwRYE~_gavI$o2Ud z=Vz~}>k0G4oQF@|;>EM4{N#r};upUCZHl_)&C8c;H+Kkz`N09Jqf?Ry7cZW(zPaKX zzx*pa`{bu2gyrghdN#v3$LnX$X__q$-hP{hkDqY*=mD26UvhPE!K1g-==1Vie-8sZ zcrqE8ruP|ILsvIklP`4|_s$HH*SGl!50S4-Ncj4u=XTSAQC!eFn}=CCEVsrIBr8Kj zuwFL`KMa#n!g)0aRO31YE}heXVTh4!+mb>g_C2i(v{)g89^)L&dO{ztzR>DsxJ$-j zoyR+?HU$P{L-}H~9vOn9+_WAytu922v9uXN^LbD&C>2pKbjD&IKB9bc&ieL-D(b`U zO@WApGz}|c0!&R}Es;0LvzyL1wSl^;C|F~n&j?J!vKKTmlDvqB;^usOxYx^h23tcU|BtYzfxVJnLCp{XQ>m?l?%osj*C| z5?^{G1YW+{5WYR*cr~ZQv))0|M`~YidN^fTC`8dGA*CGHR6*Y>##>g7&AA=`ybo&MM@BT0R(LeqtoPGX=U!HhkuoNQP ztRs!U?QP^T31=p8jk4YfE7TZzpaGtZ>9Sfh}HE8Q>=RrR+s zBoowN(Ase@jVFUQ`&#CD?H6^OV{^GaEXC-cgN=TmSQqxad6CZbx60{aDDa)=PY0UrC+3; zPACxm@DKlpi}Oo<<(Gefrqf}0Rd~FG_3fG$PoGlNH6MNR8;HqTuA<=MAN+t9PoMJP zw|}ysC0NVd%?+oIo^bN`iN-H%HmpCtrn%cvR279U z_~O$~sV7qw2ZsPWE<7njrt=w=>?)j_iQ&2oMv=qeEHVf(_b+qrV@Dsr^yf`T_`Rnc z#(IWEwvQ^XbN4L*^6=W`79UVipvk!jInbtWyRo`SF}LI)5kn$&8lsu{PGO8p8MTJ_yRH8s{W~RYB=14C=8}*4i?c-eR1mC>%whSnA-VBM5CZ zqc}Ri?6x!__#vX#I6a`yP9&mK;E565iY;Hf?%19zdGFyv7Rw3U>vLjCv_|bODhvUb z4-g%&=_B44I@Bnz18flFwk7oYT_OTa6gne#=PCM@-WW=8^kGL)AK^^N>(p^$3#z1q zhRwx>S|SI|Y9%DXWL0tX`3>hkJjcBEQ_5faw>UXjFrSw+z1qgyH9dW_)P)%bnBE&o zA5Cf3W1J@)-?^5)>1oS6xdb0dbAHkBDZKt_6`$-~$(wVa%P zO8o8Ld2d$p zcwRD{*bIBBQ!W<7ro5INID=TQIJFwrA&**$6i(^s)~Xe7-V?Oj)h<=C_ZGbhV4b&^ z5RoW4r?ZCGG??HKV{nxqLF0qdzz`?9!HOUjQWLq^23&&qLOs6jW9#AInBG?meZt`M z>oSdXJg5hH`T)<#z5`)E;qst)D6pKh^c@UE)7|ZDo`q==Xx}#6-CnagI$?Hj49?@6 zWw*U!v)S;?U-%ZQ<%~R2X1-W(b$QKnHYJ2xz)(2Dq;$O5Y}jt@c=FEMIXg$ii}M53 z1Z_5V^r7eV%NL}SSe%>^Vt(%uvmLy`dqtsh&Z9?<=(FK!-*!~>gyRPf0Ptl+SyiMM zIe-01r3TwAUDxsO(L)yV*?33{g);e4h{={PX79tr_$6N!KK`|TA0AGA&V+%BDJI7*s_S3MSE6Krui}kl`o*rCAovVXKl|-|9>xi4H5Xor85=1%Me6 zv(_mLHgqxB*3(&=pIpWeqP^nQWT}tZU<@3MqONoZpE15*z^%6q81qW<$w|)rogrmrkSNSiTPE8MI*>Z-(Z!`)mAi#&l)P5n1?$K?_M(d;?Lp7KcV^A z7wn#&(cIp$Ud&khyZ;_{(|5Tkr#NwgDeU+%W`F_q*WDUJLC>_?@%Y&vbMw!Bli&Sc zzsnCU*PKQnVfa}Wc|+pNKL@X;DQ{#EGobYf`u$o$`X@QWi z)~Wlh(KYG3M~vtV&UWn5t9^(V!POPU`&@DwjPu$dNJO%Wa7qcWU<#idcJ=p4U8mXS zdHqS3u$2zEt@jW#16`Wj*~UalCg+QwT~UPFZKQ}$&s<*B`x8W_bE;}z*bNtYn1E=7 z%s3MnNDC=DI}DrNU{q=IjKo0py^7=BSyU71GFW1!^hmb z49d=QPMbG`X1nG3`X;|mn=OS5ecxv?jaq}WO*{H+g(S4wMrX41l$9>^T$*kiV-gnPmj_J+15r#tPt9yNA2Z+K$dc<0^A{iD_A5zAI^9>xT zg)IED*%E;~xGTH^@tIPnFqLNC>sW;hy-_HxiY>?2PnrM8|H;+w{0@KcFMiA? z>z0|dbQXS?qDm=@p%EdVH*6w?3cat(XefXgmItojt?8VH(}L;3Q%#&|iHsHpc%y^? zqb$N?l<6nNXf}vWxv|;xAjPO~RuYBh`d$knZ}LF|)?0v}6Jx+xQLB;|GAGoM zx*oAnO%%Pde00&FosBUW^3w9BX@$Esu&}UPmN;*?zc_qRFstoIHBX{?qdp8Y`+bEp z8YhYtZ1?AEYGtBOv*fQ;5{xD_>Vc*fE1KkGsTT(vTf^(mKV`SuvbnwG;lqd2vnkFx z-kiN*wpbu3asK*@X1hZWc5TnD>9EFdb#)EaF`F-_>Y6vNU$Hzo0$+5Saw>K;g4ydP7V(9Tj!RF?M zi?i2M^@QbWg(0aXWisLD_!kcTy z;$5wZVx}U77!i}_1)0-7(DH0H04%)6`#nw2o*+VeZq!cCAm3;*Ezy81XkOZoZdZ0{`mJe|LuRp^FRF<-!@Dt z!`urp7s7PL^l$zZ?7#CLaQ5h1N+A`2dsZxi)r7($R+(2~p=+7nz2f92|BCc4|1Vzr z;4}W@2e0^k)AA+@QzL@$TJ4repXAD@%kdOtzSYsN#BpK@p42rDS5xLwLs?p#7Z^dT zRn3Jp*~~U-cbbEol%5_j4k%P-F&rNHOMr0&(kYZnPUN)CD(n>k5&`Eim3Al+6R`<8 z@UDxTZ(|@?r0YPG)~-w|k10JGLzCZ&D7>}4ZAg7$GA(hHBPF8@xcrLffiWzfy~13J zzMRsmx|@6VM6AWG$Y!%;v)l3B*S^l%AAF5h&!6$~*)!$`$Aq>a#Ke;i zKcbw?ktCeF^$u6BUT|}MhBrc=5>;JM&llQFri3d>imGOL`jF+(5pQ0;;O_dGvuDqE z_~Z$Tg9E1X8D}pdo4Yl;^(`?3Hg{{@e)k<7JbH95RBC@c61sn+;o}*a6C|e+%81$w zyUN9<;Od_pof{H^~eUo?~GV$2y8CabG+n{AAC3}}~PtsNsNhlM!{C-QK)BVv4_d5xz};P{(P|6-{<~q9TvwPQZZw;u|c=L zU@X_M;BMOxxn;FlVHXR`V!jt|buH%litg1*s_QGl**PghN@t0EkEu&+>A1OUSk4Np zF|^k$)1V<#m9cb*OmWo*+~?ef`>n4S=wo7TEEjh-M1MeK3%wph-3UU*@xd`}+fdh$ zW;y3Gdro@sj9CyKTElGaIefgpn3iX+&e^=#@#rT%;P6-Pkm?Y7{fguD8Ow_obieUN@Kl06dyc#RwX2!+5zETs_&QMJFWrKAT3j8g;O}LEcAH^fo_*ruZ5{N7Dp3` zsv?LbxjAHxMHeGYC-Y||VhS2wPol+UC%W8CUAD7I3%KnhSuor)sL4`VWqWeQl|Np*7YF{;{ z+%;iKq^P-kbw-gQlZCd~WHJF&4G$kv&KGn)`7xW9FYzMmdcjqewv9BKUa{OZF|8f* zdCA?Tqv%y1At`rFqEOA?oO+)+GgymHk|mMYr9e?+Wp9^=0eVS1efENSQZmDE{^Kv` zo1SS(OpIY!6x5Rv;|n%79qsE4)h>`;U-8ZJXH4dn^74ng{H=e^kALfT>EB#4_i#D^ z;~}B;_lpmXIQ^>+nLL`nqbV;C`j80#3XbyAUL!r*`-Q}D=@ytA6}cr~M(dZ@sc1<6>X zS4I?8H$S7zh>8PaWXK*h%Jrac6|*-^SBnTLfE9F@ZVbNEY;S9_AkbN2=#bDOPN~jf zjn3~1k9dnMmAU2X0@{MOX_XKH3Yj@eIhi0P5jHJu+>i{Rhc~;9nK2x$CRp!z$pWd5 z#sefqQ3^J8#OD>J9S*|#y=;E(&W+Dcj2iqFv*W@5g&AY9-V(Yt&nFFc*O%0@Ile44 zUnK^v-<*+BV!2xI;nzOIS;P9~mWzu^?(XigGp@rI1!Y;Ps=d{pnNq?zhc7D*9z4br zg=)l{%iWV1pKbk5%}l*7F)7mQc3@nl@cY3O3tv{_*nuC7_HZ;5^2`1F+3 z!3soZc010`&((?AS>FHJhb-~|lHx#%M(2*^-c=ny1GMNIyt%$S68ZA=|I2)Rbwa{i zi4XW`8i#Hg>;n4%sLeLj!*(Zm-Y~Xz!$Qqj03+;W4K`b)ORn0S_nAVc28(_6#c@T6 z^ZP|_@;$Mr^)u|DO3gsG8PDIhp~Hiug-kv)@&Pl<$kNy$B}j&l3{^el(L3*O`|<^w z%^j=5BdW=SqA0;x()y0=C!Z27uIZBcMAe01bx^UpX=#GuXVDtEt>9|MYFe;vdNy6c zq=a!EE0K`jOpy=f;iXK^j3HBcv^N`|@DB*m(7 z#Ji3cuN&Tf|1Hj5JR|ISKK_sY6CSbi z&u@78Pd_FE!{YC~&-(8QwOi??TfaEAsgTr!)@+QMbH6(xoYKw=V{FQG6{I0~iSAkq`tc7$^!Q?`qP1*R;C zn-1w(V$)-X*4aBK3yN|HF%jDyBZ+>!)s3n0(|}hS>)(fzB?|@VSA7<%TMa5CZjlIX*kvn@gti1yO{q z-H{~m@bM#_y!{r_>4ev>&Up6h8FzOZ%Btk}k~51GwXz!ziU=K6-q^KlVXkpUt!+>74Lb@hFR z;IHcSl}6f*IRd$&>_SfnDG#!>P2SHL2JA0qDd#!G5Y&>AvbLbjP0yVZ;U zUsBKKq!crg#g3xGF$&b^MuJg4F8!w!ixrfSGYr~+vGpAf9>^`R+$$CG!btlAFGLxM z04b`Y@RJYUCw48@=NGiQ9jlXLY#-Qt@>4j!Li!GeP^Z$O2X}jgr!(=sO zyX~kV9KJWlm9YNlOK#SI5H!%wJw8VMjlWH|dO%@3Mj*t5vqCLB%k2e6&;9`ad;fyX zAAO&7aD*s)@8u=md%fZF7`ZWMKon|^eJHRr4l9XX5)PQ6HX^lwN2cJN$%Kc86PEKD zU#O7J=0632C?ts(uX!dZCZy|$oq9PL?{G!7#fYNSh;oRl87~$g88$SQ+3vO?3m@gN6^v!RvI9S1OXrVKkYQE&b zbjHDh2V9=L=H&5PN@5rexugusF+)B-;U*?V8N++Te6(zynfr5R@>{? zV{nvZsjyfcz>b*!c}`)684HZ?*>J<}CnOGi(SQdJEvL4hdkWq-UK}d3yon54_#%IA zQC2*7>uo)Nx{l_v&*1V3XA-Tboy)ugn-^KTQ^h_4t$|*IGAQP2V$ZC!I1;y#@YW#` z=*csfd#$gvmW_!V;8Mv*8JY9E1t%{#wg2dVjVuuIS$0>EQg2} z%QR_*N{?YKh7XFGw+|OAR+Y{p&R`2Ob{R^x^2FGa`lv%{L?Mnsb2nmC6}>SQ zQx)I}jHo-XW@2R6t0n$-PQqz-~j@U+GT`4VBl++Nq z4c6rY$2z2sh-ZY;RJkv-YvJXyTh7*7CJt672b{YZ)xY_-`GlH~(rD~=f4z?DJ`+)7 zUp{A|KxQ4@GbSC@SIQ5$+#|*~=f;ApEHp4`2!zrZ%3#JQ^li_}7cW__Zz#%=kG}aW z<_8Cv>6mgpht4Zvo{5%|DG%TM071{=(Dii94nzyMzV9f@3K5~KD%#zac6-PA_J)I# z6G+0%#Rap21FSCyO-s976GJ4%K;L#)YnU$V4!hW;qU-L_35S zb#wD}$V!fCU*7dJ+YQDT>e-CRd`?jo>Z;3r+&$bJi#8etJDRwe;R}YZ&8)4VeJ2Oc z46otf81ySbo^^;mY{S1bh^w5CBQo>6B&7@`<=^ksD|mH=36YM7SjVzHeoFu;(( z05HQaFfc0$WEfJBRGCUuC8biC8B+F5^xi*z?QKr88wPuybMK23Q(}M5|EQ+&PQ@UUg39QNs7A>aN6{>N{# z`OY&go^Mb$5BSIl|KhLS=Y8jChJzWHDn%Isizw(AQ6$H~X;9R;s;rg4MB&Xz&GEEi zdSiy2rivp1m?Tf1q;C?BMI`yjh|5GkC25Mv7Ku0*6UjAdjo1REh2SF5r9(Lcj}#_r zGzDVcAt8YGbWMjY^(aFUb<)F(Wlt9a)xEO;I^wuis!X|gfT#cuqO%LeSc({g0>MvYg5JKeU?b}TE_7Y^B;o}%0 z-uLvaBZO?>YYf`h#N}ugtNq7tau_DW@~m zO+$>rTo?51hNthpi_)4~_g_J4&FQnJBfI@;zxA6R8?s3WM6z)nd`8mm<6}e(&|kh+ zku>?4kAQU2>{J^=;26|P1WO=UaE zTp<)Dv5{j)M8m#m=(2b8bZJez zG$v36p|qM9Jj(#a3q^n;1Uh3fVK9yD?mjHZ8~kNxxoc_)t+C#5c6rXeDVbI!K?gG)!`JoS0Y97Y0)NG z!1|ab1jQ$KLzEgPhm_IV0Ah3!)%1?24Z5mszw{N#zx@yR(TQghg<5vkd)}`xZa0jOCmweos;q!L4whtD_2GaV zz9&kktfeY6)6!sd-ia{_3&w3m?jxh5(emnwF6-ItA0E^D^uZ3&AMJX@>f)T$)m4&) z*NVw(&cX3bs_B%I=TCX@> z8FalsxOnk`vzI5l{_suO^$I0Wl_itugs$sQMEp+18DbV>B+2v)#aeC$5prcELzHBD z-i-DTxzb3;%mA+s=T{t|{!i-h$@M@aMc6prpq$CXkTB(ZBYU6JRb7^_F6?m0>G)O% z(R-X{w6pczp-W3Wn^BgZjh>p{X=CkP&sdp!?5W^ssX9vUQ=VVHA|F>_c( zpfbHt`ne8?A=#*gBwH^Ed>80?Ka#18NrHKcXOA%J4NdQ8qa$dIG6B~|rj=%W+2M@A zt0Wz6ou?B)+Y*POiqJ<-69ZKaazdbB>rJrx@IZ;?jw)FBo+758C!3ZN91lMA2JOX) zl87lS_SS;wvvca3xA15-&rUe(8zz#yr@MgPcwTx>;o-@5e!`uZ;nAZrs;OpHP3a!J zq`z1p%L%9h+NaMb-?#y`$$?ESlKNmywWulfCxkKy5^9wW`3M+v za>&cf8$7z zw?rkFvTHlkY(mSF_5IIt`qkg%^ynTdHOdw=YezICx-uMmdw-w5xbk#LbNgsYV-15&fmTTlBqC!*?PEmgT@q*V z7l+*28K7O2Jbomw7lmOD@mOSYIu9fxGwbW&e1fv{YqDQPqe*-*xn^M;pV?=~R;7 zugmjOobyzr9ghWDT3&znfEdE)QaU_BOnuL!I=vk|AD&aPi-qjQX30tI_28jp7`sTQ z1@cSmNVvH)%wJ2UKLfMd7=to;EQh_%dfq}B`5Sr_VcY)*-sAeDF6;U<+g;7)$^Nn^ zk_t%}Iu$v~A3;SKGbZx$!~3S`h_teYMpy_*>OJZIsBPZ^QfZzWWIjk5MIL?+=kR^U z!TtglA|d!p!b<;6OUle#?{K}xZkDLi^Q;oA32lc#Bf(=u;UlyW+8AhCmzuyzC3d|v z;F9k`kcbD)9ZV$+-jtGL;{C^hqyZLDQA(r;o}!o#9fZ*0qvMC~f5>b1?lIfHgS8E7 z=Q($d=O2BD@qr_s8j)hvNc!}6K3ccTHIyN6+4MYpcgfMrprv5{tpkp~@Cq+}enEKR zSzW;DhbP3=Q%@$y#B%xQG0j!aviF!p!TuLt;~)R<8Q*$*#ws`}fdz^Jm72_1YBt0q zMmfV^GM;!t8$MG{II0pvrz^{{?I`yr=);O&0H2^yQ7VZUdXHPTsGNW#UJ+TeGwE8z z5K^@u5oL?SMt3gTvPLios!DBqMeJQ}Mmt23xsnQ&pbW99XrdxSOL^-it+Di!G?N4R zhhJiK_cfjtdn{Fz)>>Y*eebc_aB=fB%#Bwmf8+16dipbtKKKEvAO8@0`hswA&a@5` zcEY1a7tDY2Q~c_`^Y_sYKFbHy5eqxv?yO>7YTm9bXL)Vx&kAnt6?n30b4UlGsBOhO zh&_goWQc%m1uu;DuUaQ&yjF?N5J|}kIYFx9Pez4XzAOk`J7}d`a82RMX@wG7tru&3beQ3^7m| zJ0cAG`}<6169#+RzVB%_4Vz6vIjP4Jr1t?OArq4G>9PxnU;ArLLderrIg1@8uha;2 zZ{1FZQ1#*+h`(%(gzH}MJO3zTPvI@OD9w-yXoXW-JW=w&Kah_GYtFvy==vU0l-S7x zV+@5g6jqI7!(rB2YnA#ILuCy+0pL2Ul`4%C2nN?PA3WL^s>0?b|5(i@@>V`%x;|w< zJ~vm}rlqb5ybrWZhb_`=9|B=f3`)RBV6Q$uMFmewl6erVq4z`r%4(KthXVqENe-}X zI%RTjNO$^z!Wx>cqtF_nV;KXLHN=n_-s|Yc#XmeWDY$^5R*K#`3WPQW3M0I5OP-uP z=W9ndS)RP){0Gmu@PQCLMNHn-z0x=$r4gcmRU7aZEh&+cNa{e&@DYDKX`^1IO_t%?Fo0k_6Gm>+mHCur>C^uQ)}4I-rhxw zs3=KSD+(3DJPLD!o7y4~UYSiev=(s=DJ^kYP!@_}uSUvLAq-PgF{Ea-+iZ{!2|5WQ zj*aEKP-34g1&qOzN%0_dUFLUqFd88#LMttZ4#eQ-x}MlMIw`pDQ#R@V^X6yR|CKKh z_77NUO;aAw6*EqyU>Oxom0*&CW{iH!YGX{SZKVYj5^Qo6HJ7(O%hMYVv2XqsH!h!2 zJ^u)6dzK%5#L-*uJOAl_Kr=t$?NcGn4p=Cm_kowo9vACzZ6q%6xy1zG*l+eM#T-$(>Xy=8FYoRk6OhVzWGF zQcu`iUQ!<&a(H;aYPsU04?pDoEBBLAr0ZEN*IZs)@Y=(NggERg8TG)fJ%+9zE&7oA92A^#w7PX_OI`S4eB?)!qawzRe!?Y`RW_U@c|z!EBdNr-SkP0Bt)#1>jz&(t2@9!u1_df9A=~M39y~|>6 zKD;9#kUe3*WfM9`)uOFyUVY;s&mMii>B$S6>*%|V#bSZ$9Yt9r8ckt&Tc}h$zlJ`s z4i1@iH3pI)xfaHwaSY&pO^f#b*T*Ny1L>WktV)KPo0dx)Jwb#-`42vfdO2F_B$urX zD21`bSRNa#ur}#k?F8&yzFc}l7#dK+hckQ-gZYgJG)>2PwZZ#I{suGQQUHY`tP(6i=Hqmo_yiBl_Gk*VO)hsvrHWTbyS8ZweV?I|2sR1(#kL>k^J7{l zi42#m0DRkn>&I%8;PGAJ?L<7TZE>n%V`pq0e2$ARe~qU%9`dZ1vz8=LUMPh!!UX8s z7LP#}B`T)9vRqZ{22Ze;-kb z!=r$2AJ@U1t;>l!@ZLr5BY&L_)jGTi3c zHtiuL!Y3(Zl5c|R9U%njGTlY* zTrz?3i6!25>3LgNin2;P9+k>vYQ%ahzUASymYBO+zk^B~Nkr z5NWzT`8K;0$coY?+uGcN>7CDnHjfX6(rWtN;auv+RCNV0$u~4zpWrvGQO3}8Jt4+4 z3=kPdAGKCY>I&%{zDs691JSA@Fjs~yc-rWhYK8bn+k5PpvJp*kD{_g651AXsamLT#9=F z(re!JEuP4g3%n4aae=*};6>{(s^)pK=F_zySWO`c+k4KJJu^MwrR%sVBR3!H^WMtw z&bz1Vy=?es-C^_bHHnHMMy8^e`Lz9J2scEif??mAByWFqMNv$cM@>1kn1h;F3WCG? zj&fS3tQH|`n$eRyC{V@{ox^XsbRZj*gF^soh(;sMLH4tcq7d)#eT$HWBwC4Vl;x^E zrvLPpc=nmE^8U?-G`2>Yg4)6!NwZ9cp6>FDmPn}f(>ir62_F}%H7RK^Dv{SnyoQKi ztxbJ5KOBykMC+1*wK1Aohx;t%1&863Cs$XztnLt$MN1e>(I$nWGQ#s~nQ<=JccGM> z+Wq=bw}n@RYqSxRd;IXR_mHoX7N zJKVi}oB7@htu#&Ba&d9R$%_+|z@59d`P64VjVUZi)G`ucKDfzB#X4P24uko3NI!e1 z3U(9y0jBfA*N}QPguwFh5^W6iWWwdyDf1X8iV`2w*-%d=^leMKUQ$hGqo2wERgF#b zoj^QRZSne`!Y5pO0G}X{@cC78L-XDzL#RGMRPCl2WuR?g(S@Zd3arhpXL%8)Ls?<8 zPE%EqNuopW7;(k))n%=n5Mk5yG^;fOBU}WE!s5eF`ZF@(D_dtNffV_>zE9Y*4|G{` zXQPrC)pRytZ$3#GMGVwcNpw9`X)(r(UeP1>BLSUB0azz?c(Yp5_b%nFG1B!Nl}>iM zj!2~v)84g#rLpXN?(^uqeY6@Dy+Yl)N4U78K6R}6E)m$GM{7mrBZbmgrFZ)fgq3%c z)jrX+biSw5nm#J}&>==s8$;cvMLto6BDz#==UC?x(!&Lc%jlVi@QBC>0Uco`>F~co zGc5~#w%IT%YE0kqW;sFde6+fP5@xR)@Fyn?=g*gX{&2?o>pt~zfI5PXfq7KSgHWNU zBiul9U~6tzOF=;UKs}$}n*dXTnilCo)c}hKs>uD0O$&HLD}-bx8~dKvr*ZQHwPq&z z;OVhxlf$1t^vS!!cS$BBT1BTdmy;v9U-_H7|KKY;I(n5(l_;Z_ioy~x{hImelzM%} zlUBHx-@#4hC`rjtVNzwF6lkN8;S_0jB*x^cBckvbI_iCbWYA zV#g1D_%`*?ZA9xVmYMp3Mx}|NE+}>ptR%l9*W$-+hP?Y)8F2lb%_nS$!jLM90Y_Hj zmX2G9CRgafFttSOMkM_6_m+SeXUR8BlS;pwdf2k0o=%ud z>%4dvWlct&MSj1SGk^#n5uJUTku-i6B3vyu$*xmr*2@iT(}GgCE@9n`5~h25St7+F z1gt62WJVrW>^n!__9$zTyhnzzlqr}^Yv!{$jV7w?=Gs*Z-d;ar2IR&vI1)D-{A!&h zYa~sfM4+}7)oiG(ra;iz(1@XW@POj}y)j)H+DBnBqr86?={n*ST=gA@qE8)4rrKbG zyY`v%L|*hOZcq2QL5)%kMNzSF9UYNEYYN|Hb0tX)`aUn@tnlW=o z*E=O#bPc!58Ov_PD`mwKrD?j3BZ<819nXEwbY8P5Er0y;6T}5fi0n@)zWwwiF?e)L zjPgkk4x?}*YP2X0qi{QxY#N8u8ap$X+Ti*gT`25+38jF^__E60-hB^!90SR)p74FT zF^XgZU^Kq%Q?jB`KSb%I=j7TBI!BB>QF~%(IgJy}?|+u7-~N02Wbaj0<(#50lv-n> zr|wo9o@l9l12|NFPBWF6Rc4Po}#pLeL4h!_mp)FG14_H zz3Z?=fiWs^QUV|;8%ky|$%)`= zt1Awb<*+O{S*|FIpme~mHwXo$(1bj%9F0QiMAGY)T~g8w=^p!4n^soHLk*qhy-)xE zAOJ~3K~z;bTtx{{D`MkPlU*x9pTrV_bA+ac=s)#Hs!&6 zLW+cpem7BQTt8|&4Ug7&nqCMo?ZqKsNnEJR#mcW8u=xRg8OVX`d_Rr>Bpv4duYqHR z-9Et4lHc5gNK`Ud%wO*ljFr#!^~0CppiWcATN3bYz!?aM1Co(>ieu$5^lMy9O5tHA z8B7&fs^o@Sr>;Ghu4GWTP{X}KMw^G>KBeDz=br3TN<$$x_!R91luzREi3O0NEU<-5 zK|mCxO$W3wdVEb9(F1le_faH0vL$q7+)%460SD6NLn5mtjnr;7EuqxRW>Zd1FBrm6 zJ*k*XYc9?%DC-Hz6odfnrlqLLG#B19OzIjT$*Y72(@9M=sW3)wNAVb@K_ZTTQ8|#P z?WPz$a4n1;C<3_EiWmZYa7ajO=pqWGQYZ&T46)R3^CtRJ4-?TW4vRf*D<2_Y+YcWQ zoTGT&vkvLK`j`xIWTZ)LuiGO?aQtNTlF!cfv7`oI6X1=>g1Edud?1QpdSgz!yhORo z0ydV@%JOo(!g|j}BCSfj78^B4Kt;!k)pKf~3yQT$(_5Ee&7!P$+H{S&}L!d^} zS~%Zyln6J1<~V8&L-KvUK^mi62G8ECLe+{zU7zt=Q;W}|0W-N?l*9LLGP0=Vr2}aHIznE7Revo`N*bq zwB92jsn>>fP1!8DasGt8pZ%Er`)^aO&$##LdsP3{*ZJt~mw8_wp-e>~8a6Aw@lXCI zKJ~TV;_h2tLL?<^&Zp+CH5wN@P47n?sojSQkmutW$w3&S zD2gHx7i01bQ4&$s;QJm^6u6jheD6AJRnhm3&2pKpQxf)!^VD^fMta8}kS?`! zFrFweS5bMh4S1)p&0<2=5q%h0s;P;c`YT##q%hb!$Mg>#;*H5aZy-S-uhI)d2 z@PIl-nx{`GFsy?kDup#$rt$EY1-M~rbkp&y+%TP$L#=kc>P!@V6 zNh8$iny%K_yD*vkk`W14o#MCuQOvAfH7?k}niRH~^>D{k7P1=}+5?#n7!OW?tg@T_ z?W*bNyX10KT8lP@^OvXeokLqYPONM?m#1z#Q6g1crC{TI;(!=K@PX-U%4{~pmc=@o6;FfqSKI+|+Bv6M`eWK`rv?XU%h10 zHxL63!5hmY!X$v67OX|EL8v1X`PbGVa?{j^@*FHCteXv$O%+pFCvO)-6H5cZCGkT8 z$|lBtQ51OuHZg@wRf5r5s5C}Go?ud1C0~x1rj=Bwkt%tBbWPyw{+qn``ak4HM{lC` z_Bou^M1*#|=I+aPIr`@Rga6C#uzwsmekiC}jko)phF5tudlS32Pt=MaaMARrLDg2J zk?7F(^s5!>*&`O;`q#|=>RU|Co-wnA`9xEcmf2oO{n|d=o4>;4;ufYT(qZ3R@q<76 zV_y66uW;|R&ww_>))6Ei8VZ$|`iZ0)k>H3bvbnZ0;?{L@*q<57aUqU}@4znK{;Lt~ z8Z-Fxm1_s}2!myaYV38yEle~9r5MLtDehGEDS)IZ9Ci+8u3yjp*JG>{$VndCWOWQ5 z5>aD?bbU-Yy>@$UjnzyBqsHko8Q}OhR$AkGr6mna!t|vY;$1TDDBlYX($fHng*AhIKQ*aNBQ<*ldL4 zG0`-%-X$Tw+;p!13WYtIq8_|XJK4`=YYrA{g(Zik<{+IQS^6MO=S)8LIrKa4vVQy+ z+oad+f>;8~rJ%AERqQ$JJs+JsV*|82G zO^|udRqz~`Kn$Lzrx)y5i#1suUxW|^J1IbUy2d5;ztKtHu65`-FRB2xu8}O9NX*Kz zJ{fVv;OV;#W7D(@N}#s%n}${ESiSjKKKQ%;As-&TPBopQ%jAJRaV>AW_Z{>f{IAIQ zBksPcDGv+G;gr_Rc~X9ncVGQY&L;5XUuq?R_QNPzy;qCa>d>7cm5m znA|ay5|mHLnBGYmQxPd+5V^J;Wjtom*YUZ`?bt0F;&lk@phGy zXf0#oZYY(*&`=zI1K8HjGEQ3nShe$M59y8M@-zhcuBFc`Xp^&T6ikjL*w~M= z-gEYn-#BgNA-mgVLFtcK0J114-ue_$6twSui1K~Xh}wBnCh3P6udsc?`D)3}pE&fi zq75D+5xrmY=&E5Ofify21WM8Ys8!OUQo#GcGa-@UCQ;C?Mf&7Jeyg0&FBbgt@`RZW zOoC=3ksje5mIDt~MJ8pztSmTadNv_aC_#t7Jn#CFNGvou2+_At7@RV6&ao&pK|JD; zSRq(cP%KZcsOvJ3xCW^alOW8|#3w|2@5u8*Xk(IGNui)n(6wwD&+4r&@ZQ(|T|V4@ z4Ktaiwc16h?t+_t@_!)T_y*N<$=x?=)C}UR#w`zcdi!g9@BY_VmkShzA)gV6bg?D0 z5#KlLw@cq91dnA!FHQimALGDmfXmsGv0J_17^j5I_8oQf&to z04k*@jlp?Grxm)7T(&K5|Lk2J9N)yM2_HPWqP3m1Jo#oO2-*%}QC2d&edX&kH z^e6=HFm(YMy54hf*>Y0tarODH^Yq523H1bG@&=i&FSzl4{x8^X{RxX3JvZK%AoCLM zh5iKCSM>XLh{X(z#)XIv9uTZiSP%2CV*2(U(|qF(F)v+{HLX-^w4v*I`j8B!T<}y@W0YdkI-CpHDp-$7xn>7aW>~I6 zgJUN{-kmav*Akbs>by@phk?ft$cO%r_>KE$s4m8=C+(pfcq+tUY<37XiS(O#rV$an z}tcx1b0 zcdu=D-A><<9EgT19B(-Te`ROy@4$hdWElCxh=dniNaL+4NwvF>vY<8#(ap<}WI4{SQmYTe+SL*<3LX*-lM5Isf-)qFxZnNXG`g*AC}Z)=JZ zLNci`uruA2kL!Fm55ZsvW`iv!aeGaXYw>0$=rD3bK!s!`WU;p?U*CCQb>y$H~G@H;7dd2(C z9&@8CdA8ip$H<--stD7lD1#%!z=aNI6d!4*L?~lqPlO{SDTA%1obJu|le5RnT#v?Z zCMn~$3Q7XB8?4c+r034jg7e-nR|aPT&w__8aMf<`z+5y%@bn7G2--&u7B%%uBjOUg zsgpWvb9%*Oug1=b(bqf;D=5$k6&2ljlbX2E6FNVpzNWNk>PHLbr&nAt#r%VRpGTkm zDwnEc&lqYY9KHOA`hWcIsebl-j_<+z!5(IA=z4{F*&&X>w%|$AmBSRV7bD#j%euR56NS2qtZ~;aZ0P`U?*& zBhk=>m@RC#ur)I9QF0YB-tHkFUMm5|!JOgT2|J&~!RxSB{*n<1-(B_$0)#P=m1^6R zr8v*kYC~!52=jE#p<<-0YYJVh zq-&KIzsrmqACt;&BFZI62Rmp^?^F%}#&qJZ%fbd9iEV(0+YByl$Mw>=pBj(-`8hs% z`o3e5tB|rZ*uxo{`4I!4GW1b~EKo8?JT~-lPibt-%b*H600p4Sl5p=H{MGsRnM8zh z-+_iw6$GVlN)rN1LgZL_>b6IPfI*?cu%MF*VkBULqS2NYbR5OVK~zav1fj7N%i|;d z;^HZ;@0g3_P->PUENqRBYu3SYqG17u(!4lZQKOmOu9#|JHY<>m4Yq|V9G<|DwTKor z(Xl_DQO|4iq$Wm3=zD_i={iq6udoxF=S~BzZ4o075*aTzkB*TLdZOm7EuiNkKp*rhJHLGD?byLCLPDD!TOw z-#55KrBC}Tf4DYg7^`jUXhmx1nLZZJ?(;b`62v+3)Eb*p?SVT{CF% z8AY;q2r-d)*@E3_=UmuMq~&+bFqO~eNQg;Dc2|;K0l)Si!)w26L_+67YIgeM3DWmI zRSd=uePFY0aMsap8f;aiOv48nrBhSWXspeR@0jMZLkKvR+~Zu^01<5qZ04Mlwi>UYFjHo3#U4=34R&In?|Ajz5s$kQ&R=dQLo&dM8m@d# zDJh7l!XOhtqR>8TC<}}CJ=zFj6iPIqZIBpIl8k{=Nb1hPcUx>BR|v`$#1Of-+;Fz+ zXb$ha?M~ip0jVckk2KFMN@M z`YH4B12{eB>d*c)(|h;nm%<n&Nq1_Piv`tS?@R(HDhhXx= zS;QKlDixi76LJ7?Pu|BB=ZG%or~AbDK58<>X+uO4BypBRsZk_RiBMQWy}yT2`>AoC z*IEd1oNnxvOZ@VJi)O>*@CNmKo?z|l_ZmsCq1I{~<@GTlF`XZTY+rqGPP4p(5Gl)o zb>HEf$4;h*O36U$9PM(6?>nlx##S{^Y4#5fK!n05bR4Sqyia9!oH&j!)|f2Hc;1gy z!}$OFoFdDy1kgEXWHH;FDyc`+#VT zkI9h5xujz0eaK_8No6<2WFs0{N4IV$ou_Xain5@nYqT**Jy#`NEg{mkju-;fw5F&k z%A!P@bi*S;?*h)bBvzLfg3eK0DM@BRY!CjOq+tBMD3I){O$@LDUk!m~z;!dilwLYy z4teEi0hX79ronf)Q60e=gPt0i>0$1Dx^-7NTh8rljZ`)_Y1Vh!`viOP~gn1*=QeN^#;=97e?}4k{v7 z%COl#;-|~!RPBaFU<0g!M=8a<*#X^p%^g!g2S26dul$;ar9l;%`9+5+ z&kV&h25bROT~CZcp`dk+s_pPkI(mFE_mLdv`v84X$aSu#oK6riiA~;hgtjF{hiHw6 zPF#>u6Qg2zzGSubTslx+`!(LX`xd^OGb;=S&);GB`~NvN9zUik0>`hjng%DJ`m!zQJBi#^bldR;Y^QVHe=_5XQ*0+ z@^p7nY&&|al(2gA5uHy978j`tgDMniR?!#poT=~&4V7_2#*auU9IWQAoz;% z);^EE@#ie&g1G@*U7~Ew&42h6{^jrgb3Qt6IE0Vs15yi<*dKR}zZvM`zJpbM$&)+%W#>1L^bw>aGn#rA4c>3a!#`UaXK&g_u9$qg? zjtZePpktPwZykE2k#0kCvZ9-o_-3n>7RxE?y&D8$>4KssjB*>mIFi;uRQ8WfVqj`6tMZOv6qYo3NzqSwHkFcE^9mQdbF~ zX}Em$BI#{KPbmtk6{=7Kld)OXqI!=K@RC%BW3GOpQe?fC^qv_O8+C`+y~aE=C@K39 zy)AvCBqH1Cdd)^0^{iyEp5WJD5NcCUSeS>BU<$-V3LO$dLupR>HT%KShRBT&nHCj~ z=Lh^~d4_6NN$wqCUxZU}ymR@Io2CX+^4X(Xytq7NU0D3YV7%pZ6=*`F36Tzmjt+ZV zapR!kaWzAQ44^U=-wh0SOfNgc2k0hXDD4kN`zQ2^eC5LKG0PXsn=M z5i5?39rxvOxl(=in%kapPqX)4&1?oA=30C2d*6Fyla%WT)spT#=j>*!z1Ny+H2*Qi z|4+uaC1qwl$-3q-C87_g_k^xPV}?G(<~aylNf>&{SxK@r{U(t<^1ZxPpCZ=LT%6&5 z`lmR4<7)_T`_xd>27lQj9c*9gQ17U3RG97oAN*4vV|eWeZ~X3?4A&32`{5N|{=2`- z!>`?^iArM>>l3$6mXt1$`aqikRt?Q@&DUPP;#e$;ZO?~(=)K(gM`x529J!8u)iE5E z=#bZEyBWCnmCy0o)rLY1cNDJsp2uQ{SIR|GbLV75T?$PIRGP95yeM|=FsBaF8tC%c z2+a}0>WCrk)PRb+xm?<1uuY+8(a2osLvVy#dv=d_w5B&p{}VbOAiABBYAfL?`(wR4|@ zPYZbc+WtEf)eERS!NxPb@#aHbeeM=+QL#$UZ8scSp{PshuEg6S*J@PJ6nQ;tsQrLV zfftf+Y%3lvSA4pE!rXT($vPycFcaYv%OeSRjr1w-uv=4`nmY<_Ts)yER@}56p9WeA z2oTo;n_ekv!+=2zY{cUt9EqhL5@#11?mmB-JA<}aX14D;s>DDc-Do9;V z8f#^y5KQHe!s2_y%78ZsiiU2hl<#?k$IrjaP|aDTp5kx+52P=BhUKbZX?p4k^h)vT zYpyzrZaR)mms~%5j4j}+f8&=p{rFwp_b-2vFaOP7;fp`>8gE>+T*t_fu^ds*5xBhC z5Uo$1 z5V<23u#`aEM>c(nZWH0sQ(5Ki>5^0@%F7mO3mg@3bxIpnyS4H7Ud1X-ROS<@ppNqu zk{PJ2?275RX=8s69CjN*4&p*mf{!SMqN-5Ih4R$*Y@eJ{%vac|LV$L&rrT`rea~XC zU??mpctn-!>orjq%rhehn>w3Yp@!L+W}`C<)Q#% zXqtvuT~au^?{+%4$9Kd^a(MUW^}VwNV>|94q;>d{-QTivB>7xT^D?r_@(w-IuDy46 zI`u94{B~~dngemxaI%^|Epk7my?ef#(L;~vaZ^|HM@zcv4aQkghzwoFY_UKvbek<0 zn-@z6#1Jy6p0i`IK1U!$;h0LyW|Wn+)}SdNLsVCXo8PwjpVtD;`@IzqRC0gq! z1>$MVRp&V>Ew*kbk1NU-Uf{ZZj>yxq9RjC`NVh;lZ zO{{9eY`MZ;4!K|&;kmLRr9NjEA-BBx~!= zs%#>nI8v7d#A@>@_dfL@q&cDe!tb&DOv%Szc$N0a*SPayO)ZY=^Pa9+Fo>sCgKZ)& z|IjPk_`#RxuUEYO-~R&J*Zv---~9@YzWRu8vE?~(;M51tpim{@s4S6~ppDFzCACJj zR{<9w1!a5Q(n9s?}XKCX$hWNHP|$1&%;Dn^P{9XiBUf-KU%_@;p{dx%0AcS^uN;%vLLAMa5>b zp{^WdRpoo%WVY<8sYu>aH8nc5^Ou?4ACu7rbrx6EL~{YoQO@QZ9UoCuB~t})y1geO zt~)sDpq2NjJ8o*s-A9?z{KvC3k;C`N&MobCXvb%!jN|EJ>3-ku;`T02qBC|4#QGMEb2 zQwlnDP624jdf~=etO=wc;v`dXwC%uk8yF0D0Yj!UNXBw`K9Dpqw2D4?!s^2E{7FMq zF6r&+E$8~M1oGv-r~J}i$&cN9$@1P$IEqTR_r=Ipe+$g*e;1j358cCmk9+6W)XNi+ zt8gcS9JxjO5pYfCk& zx#$A-kNzxQJoyQNjQSSM!HM~UWc=m$@Ba7?2s{Tj|2cj=w!DA-U!n4MSO>?OF;cXi zQ;o>;4cdFU-?`7duRo%G?g+OksBh0{pFE(uYMCcEtt%=A#iHclcHsWDC-t7W=ApjW zMWR&<2LHsf^#jHW##vl#v5jRIl&gC^vt!4_|JkzlYN`EcWsdH+Na%xoferYSr#_tVp87? zbbSPqp{z7=R5hy={q+XxEHUPeD{C|LbqXP?%B3v#X{^C_9Vv!9B;-9q*Hbn%Q(=87 zq8kBHF3QEE80(0k!xawSwG3UC3-HGa=5?7D8~HL$#BfbjjD&LfROG@4$BBXHJt=q$ z39mj2+?5Uuc>;aVgdY;g8hnf_7Bwa%wp}1sD}Ozo=Rf)9XZ*mQt)D8szy8_4|M(ZL+3?3O{$C^B|7pG!A91@mqK-A+c(~+pH|6U4Ji^#0E>cMdanSk~Bu!9G9d$v1k6 z`vdoX<8_8%z-%MeZJq#E6~u!CMV#kWDco8uXnkUH<%!;~UiX;7z#w$%!1B2jeHU1_ zp410|M%E!=)lfMo7mkMyH!PxKmY^Ra;;kw{4ade}eB#I!I1wOH*}$96{~MgU@8jr> z;m`f&%css&itvB`H(P%3Z*~0EUo*V;*A%zho330J8JjnD^^tw|p9q=DNf;IQrlfrj z8@tkx$`Y)h->g|29ib^Qb?~}_KK^|$IUOh42HF4m)P9h+`}+VtAD_7W zKEcUhwdUKmy=#MnuWdY&0iVYCbu7Gvm=_KyNAzMH)!~|U>oPqkXc!WuBVzc_z-s;5mO6n*AH0d2qESf3$ur}d_OR>EmxY5lOtl0 zpR*>n1|PDKPU~aZL<~dUA{tpgc|yCs=5)2->imp;yQV1eaAWkIK1OP5m=}()iAWz= z9amrmf;Aj3mQ*jlLb4Wry`{UjjSzUht70{?->5 zfAeR1{DwuX6S=|f`CSc+0e$r6&~EA_tuz@Pa`i?=vhV{^dq#^)nn`3=u& zzXm-cLDEVe^V+NinO)@pP8%5&^YpKfx#mOo=46`@7nN=i> z)JJ=Ju_q+i8}prgJt$l}WxU598HPI$a!NUo(1SOO;K5VfSBDwNVemhJP!k}(a|mw- zGrdhG*W1Bi`%n9fgBl%=3jDMGw$PaGut7p4M=O&seHv5B7y=@O%2~w15F#3(o|QP8 zWm#2I*6P?sjB{WNafGpql|58tZBFt`PHnv=!VqxA(ziXXEXK|z#zDe_CdHN|q#k1w zQ)i9z!WdGBh$c4Y7a6y%D_mJnSc{lU7e8IuJ(fBCt%(QU_zE^9>bk4E--*;&AB#}HM*$zB+vu0bA__L0>^u*N6u|Ab+0*$mudT^9_7@IbyDv}z%lyFSb|34&bQ}X1R1Dwq!{r}}^8olG|5C-L z{%+6LK6T7*-~Ri23cv$r`7_F6Pzzit{Py_4->-*uZ1?2^L0@4X0SoZL`0w{aCNdpau`EMb~@I9zUTjEg>r2X9r`-0=iuIoa9Btnq5j<&T5LX93N9s z2p~#-y}@tWJTPX2U}Tq`YEp_(fv{{0ame%yecuy(pqkI<+7@eIeSS{S)D(4tD+`WR zi-Su&rl#Y5V@mjTO(I}bdGg>P-KNENEh%N2ETi+Z8nV$F8iKUIS1Ed{1JJ$H%DTiUl%ww<4Cp%r7 z!n5b$LeT7)6|)9m2uiLDnmc;#7Bm0 zn_;e$GY*`|Q}2@bcHGF>lWQW0&1M5JAysxZwkVKc$n}(@kZOjqAXRR+N{k3GW-g}f z^)+$WpsJidJVSiU+19AhnKTiAE=I2V9#W(czzPA&;0lVqCv}M-1p21rYBTWYwMV>g zbO(ziEmowH6Y8T=+G3e!QS<-{HbObh4PKuo?(+7AH6>V|KdZ6+|KIJ=*Phi~{MK&w zzx;>0|8M7Z{rH<-_v^F#d|h{}MCh$@rDm7m3z?@WcTMh%@zjx|?6a>aLx?E{lYQ5X z6W|$!j>hKJ_E9d{?i_=@#c)ph6UcQ=IjC*wnC&EX8O&ts%|ZGy)j_A%bGT3TaM(m* zG=3Czci8Up?d7+py}#4;_KxN49sfH$CcvXFLuJ0h1_{@L@QHsv0GWzeP@J{9sp+XD z5TLFqE-tSrs)E&W#-{CaLET#7NJCN9CA0aQ`Eo{6J`4{&4WItGo)3Pq;O(|A{PIA*QRYW$e)PwFnKlOI zRYlVc5F?k?W@1VbXd?FgZYHEqIgsPb*Rd1mC9Bt!9MFD~g@Xe5aRY3~5$&wXYLMy! zr7AY$nGwWr6$3BKDqJBHRl#=MVuw7r8KTn6N|M6)!`T2p5{ix>y@9=&9 zNw(kmJ3U|hEl=G9e*EA0MHVkOd>iS{TeiKjSX7)p+91|Y#6(d#+Ah$C$c?(BT$Nm( zcNinoHe0#Q=bO@%md*!iYmwT}M@ZW|9X?yt#O*+54aqCD2+6^N!DGdY^^e@#5X@dn z+^JFl$q69|r7F=GIv@Ez{^vizlY14feJ1eI_q@GX`1H?Z?zHFbK7e(_tKSdy!B6Ezosw~_OfwRP zLQ}hFU-wk!lhaWc>oa>}pV2KH@As#(g}p=A|J)n#5&zmvAnaRrRi9?!e#`siEx-Ie z+gqK&v%Ob;|G!Sy@3cWeRi!Kos?u@2?djH=Orc&BBaQnAElG|jj5Qcz>4ret4Hz*D zK41{)rsBq}8(E@uqz;cscg|?)4pGgWRn207t1HT?%8|kddx?Df0@d`#oTdz z(eeEFrKb^_sb%_uKO+3z&nTb%xq%lx)bYtb^K=*1y)Q)m_y24Qz$+j9I^JfwaaU$e zDCq-62QnxfAx4_9VydDuMOYXeS zV%7kA$8Bc(m58xIkvxvb+zHn{P=-WL%4`NPLOW0w zLf?nH#>ewB$-7oA)1TWxDGI}dNz`JphPxkTfX#bo_ZGe(8nL5eueF4 zoEAbFBE6kuSZ8t$=mCrD9;^v52Le;JqGV>>6qOVP{Q8>EZn!*q!s_$}wwWQuakN?h z2}7n!5t*1I4h-}mhBz(k!>mIU>tuI7Of*G?XNK{f$sP_8l^v+0BObPAomtioY>39RTVfHQs_y18CSje4av`SdysUM3 zzN4v`FBi0ZPqSE1H&y1ylKg!Vf>RJHRLz|8$M;FDrpL0`c)H;}$9HeDDJ~J8*-5Q6 znH+71$dr`;Wo0m{8uRc9=PVf5isSq|aD21j>d6&_7>3ls&PH)RoJQ*;!m+`S>6C9A(w>o4@hheCFo|KJ)Y6 z+BIC&flvO>KjOPS_!>w-3W8q;%2k8$k+g|8HFRyrHK-x6DhsZ>$H#>2!IU|>9eft$ zipnTykSML8Pl-|#CqgHQS}eh5^3EYDZmbLVkaiiKijV|4O?ZV;gh-}Q2k6K191w=6 z%rSiL$G^nuZ`|VXnJZIC^Dreq;2BOozr&sh5mQ?{dCA+L=zen~R zkR14oXWKKM*>*74H(7W34!^$}+q>sLQle}7+)-7QR85WVdxo|nbLR+j3G4D8;i4(o zbeUZ60>s19W5z&E$z$HO@?Z zQ?uP}sp^WVDsi(KkzAZdLC1E(!lcYir9xTHakFC{z4?&U=`lkD@jcyUOSzmArk3Ki zr&-Q+QBC0r2$5#quvN#c8>`Gy)pqpK;Acm;`7w{b@m1`+))MGoc9FH7H#kW z8?zXYb0v~erVJ4Ujfinr5-}xOKsB0mS=LKfY zV#|WGULzO^2c-%@6^%;tk=aqhb+=*gk-|BmW{P|t10VUwmw5ks-{h-bzfHSs@Nsl@ z*_oZjyF!1tVyx-EuGD`SreE?-;Y zW(5?v?YnV?3!l$bBs<^A=2qG=CK&ShA5_qkji6U00xs>#r77hgLC1kxk$vY=)I=Av zu?#3-q&g3hvyGV;22DhSK@?Ah96ec3OH~OH`4j)*Kjb(6;Yaw=7hdACzcBFGU)bNT zi`9mY{lKSr<)us7Hv|k6#|@h9;ZBaI>=j*ggc`HU{*9O&wU5XsT|3qqGD?tkkdG0; zRWr)jjH`<-%PJT{=mR1H+pA0FN5`z&o){h8*{m)plFz*vGnw77a~&pAp|hJ6>wKVg zhNe7FN*tX>9{ru{279RM&~AK>Gvj{9zI@7f??d=k(U@LsZ3M_plzAq+li6BL=oxF{T@+jHng@6i~rWx?`zMeida zNzOVnG4#Vz9Tw9*_@yeDmnE*SB%2ixr-ItV z)sJLD>Bx)Exq_mpAqBRZYszKAaNW|bw;+;vew-zBTl#LuU11|wUDXx68g8C0Iez{Q zVukIKhrDrr%Y(~no_p~&H=lnV(w5j?bAEBn*-+3p%bn8`oG7Q2Ve1o{pahLfT_Y&G z{Qb&{pMd+n3m0D(;-D<=3NL=2(wqo}n(F13iJO+TZE@n5xdLQhND0RFXiW;n?)veg zF$`!XwH)cYl}yGcszi}d7%Mx05*P(%DG(N#BjrI7Ti+qhQcA(~c8hfdG3NGOKSXAW zlFfFYtQ9vaF_p!4k;;us$~#jaEaqE2`q9_vy+^E}P0Cu8l~@V`g;QpyHK`j&&VtVo zs-5R9zDKXG83xb1au@|EEfz4>DSsy;q=!R>jSz;%Jz@k`ScV}`sW1QoN|~UshAR>S zf{S^bst9p3xci~zY;Z&&`joXQBxhoM+Cza}a{F|xS=S{3PIK)^6}%=K*@#6lwBk`Z zqs$RH5^5YPtNb%R@H>3p$G^avZ{Fnks-db9x1YPFx^W*h0?9#XGYiC3PkZ?QGrM4R z>lis1Xp03}l!$divPRFOaX#6>Ny7*Bh4!RiTuH)G%;tocD5{zm6W#SS*YXHgI7(a6 zwH;SohLdesP?hEAOfnMSLuR5d$8StaF)8M9H;|l(K+K=`3~WuvXZ%Jw}Ah#U<9|sdF`kZR_)_$Owm6fwFX2 z3*8uIvx>TOG<8W`71UKpQMi$cWIy;fF<{1|^gd*^+UP0E0$WuXDw#CN1t!T&*cazS zvP9^#kgp!Uf%l&E`4!8XN5l}QW((S@H3-a4m-uZ@3=xdU!&fO$*EMm|vAVTnJ$PC_ z(9BCJ8+p8i&BYULzWgdxVHrZf-~n;G_dPE$pUs$n=*kL}L^MTI_QY_AK`boq=EC~j zj|!)+LQ#)Xy8^|0!S?J7={mN4VCG7UMr=y-)=;=2!x93?2%Sb^@Dw`E`byqcny_z^ zoktL8cFQcoj%L|aal%zhB!nur*-<-3>;~+tL}Tu<8@4@CSmITW8lf8^8WfA6E*x%NGHeFQ z%Hmc9F(gt@%6ZoE@asVGxfL#@Y~T}lpwDS;-PW<*CIUDJqa(IrNaLV`*OZ$RG-q#y z5uPG3%{N4pL2^dzMJdMp1{oU^G(%vBAPJaeT992su-#%bXz>4qTbV*(4?CI>M84ihhGbK`c@7EDjtLo5y>M zag9t$nJHy9U>({F`9&r49_uW_rX>yo^U@Vn9MmnwTmI=5;T>9W_$u8u668M*k#cmLG12h= zV{(s9S;gdq4js<;w@htdhb{Fl$Q6!sVjdm?3oQ4Z(+8C#g!Tv$=g2rKt-Rvzl3x9mcG#vco7Wg&lj+B@4P3 zBX7CT3C+rgA;U1n2+rDk9FrqMKXUeq+4EYdGES}MiF7;eTa&W6dQ3`*?ZpNWOSNcN zp4{Z}!DEt-7*}MCYRv`3q9_nIa(Ia$h@}uXyIM2&L}e9G<>5MTzV3MC#hV5~I)vSg zZVLl3VJb^~Tr>DY+j{!3AZ@bEM6D&nKoZz$=7%aoXpB;uEQq9vc!<^ zqt%%p4@GkwL9z~q!dTD9U2JwVI%$MrN@JL1%>k?!YGZMeadeqP6vpm1xK*w`@pc> za`o^5+IIv^T%Vm&&l_w}j`f(SyKBGp&7t-W`(Gx}gk2nVn6>1)Xb(`0*+kkogT3<@ z10S?Q3U=>$2Z-t^2Pc%~4|m?_owj$a26DM>aaO47nyM-(jG-w9_V=XDtRsnFjKhrDm(yaetl$ik zQMn#qNIJGTYt~&DZ-ykYTNKUBo0wN$M!x(tu7(a%HM!UrBEz=B8AA~jX9`FuN1GbQ z%tG^oe?I*r5*69G^dkl!2#rD|DN{(OA&&YiK_CtT7cp==o0Cv%h-^dVMw?qh(Ub)1 zDGLiRvbZxx+lcpxt-z2HOEK6&h)EcXunuu|PEyJ&1lDHFYVAjzn8M(_V$L?C@$)EI zo1`FT3Q2@{?a(0+QlcsHkY`eeeaQHIf*2!~T%lA zjuIpqvwO^r#oEc}Icu|Xau(|hM@4~ZhPbR4962kGK7tWU$TLW_2-apJjVfJ=x&DH3 zVhq>GvoZy~^R$|F_fzTyv?);u_-??hYQzYdKoXdgi_~S<5FUILJHJ7Da*M8-5tx)d zr?%RhWli@}i~;9zrr)gQM1R5Z^qBs711SBr%^8a(tg&E(I7IsOhIah`<18mHzC`Q? ztbxttHSOgk)`E3H=zCD*;?YA+?-rP{rVnXH47rQ?N27lDH}Y)NV!w&(A+E`$z-U+W znIihzy?=Vmgm*o4kOOzJOWg7S-|6#wJGXajkZ}E=;OOOm51y0~9g4N1(2pu&a;H>P zmGoWD(Dkg2795`(ja^R%h4OJ2i4i)Qi~yHFXurS6l=|toD5kV?zldSag#(jz$Jp88 zJ=QsVhz&RE#ZxO^lisn6^r0CP?R%L z5RwnMc>o19=m;?>x?>Sm3~CKtGt5HLEM!E6c0_aAr;*I#WXR-;DMi#8u7hWrl({H# zu@t2tYzEA{K(_-lGb9F@Tc=c;f%fW(!Q{>`n{u1*)<=f%TtpJBX2&@f16DCrhO*R0 ztg(o3R5R$VI-<#rqf0r1iYTGY%n2bT`sjCaOo?2FImEsNp+#AU$=}x)d`vjioW+S? zlBE{IR{dzeCMT?P#Ef%G&d@4jp(wD68CHa{EGcF)hVk=I6i87JgU_8^A>{dx?H1ej zlqnL14y(e@MS>=RCQ4T_#6T|@R%%mZqiH0@6bb_j9v_slu*3wWG^kgk$c8#LbAnhj zdYZTwTGRVY+H67hndf#FDu*PJ8Y0}GgSPs|747o zde64)a#|TPkWrLb9H|`TYG)75?%jJGQ#2ILA%jwt4KcKol2~6}jH+o_Uw+$d z0fVa=tSuRamZq8Giacv#Y=On$#IP&`CqkQqM2?oHC@7JmNfAYhn%M_FK-+a}9zMdE z0`Za74_pWou0X9Yw$&gSDO7Reby2e8R&gW&)qqLaa9VOVl+lC{izm^H(^+a@jqD7L z(X855q^ucVt{VDvi(NRJv#1Zm%|QL~E105!&wd`aX)z@FA<(5n4|HgTkQ9<+hqjHm zWwzZ6SWRdgh!|{R@qMCfDoT3RU1TGfT0M|5)3D|mPEz|b*o*QB$@tezOwn=Psq8zWl{7+cV%M6VfEE6Ku9g-B*!Fo0EtZph+I zmYm@f239jJ7k42A%3)1g9RY%kfn- z0Arha3^D7V`v4m0t~Z2kK&s5Nt0`ffCB+dra5l?gqZCy`IhzxcC8Gypb~i$=GKF3; z+LmdwUH76+Q;;y(q_-%6?zSoGe*0}dV0++r*w<#K8i*N>nb$|Qf4}roN@2dk1_{ON z7mbXAO?K>#iZKuG8AFDx<}-@IFp&aI6!6nUoL~~W%P_`^ICZK_(G7?E{lMfr#>iWR zJQPQUt?IgAPZT#r(l8M(h7jpCTVjlKC~`dC9ovY-RV!S%;rjk#OjBX&in1xOCNYo* z!$7lIvhF*OgpYYDzv~l^?_YCzbH=SkxY%B>y@r&8p)6>cilarzy6t%5jn|pg1=ePb z@NGL#lorIWx!N$F&pEwuf_31mP?obSC2Acaj#W{kB5Z>)96ILdq$;pla^rhGO!uq5 zLEjD7s7L}-(3l;wsNigY!;LMpkx}qAcY%%2Or?3zndvydFghE@NUSNaMc7DY8SS?n zMl3~wr5K`1T%T>JY}U(2CXu#1K?>IQ9x!|5W%SjT&@X+1B6S%Tk7GSXvhnUv3V}*2 zZOTKPe()Gc1Qn7b!rEuiBx|{Kyx{WDHP;%6V=$HXb z_Bc(U?4*xjO4Jp^x*;ANGrxTs_r^DfuiYnXJK~UmCQ+f4L%NEe2=)& zQZ$jc6@1%KA01IP5o;2UWrmrL{5c1(3*$XytQqSDva_0DWb@UOFh#-8cDS3z2*S_@ zipFA0?u0C=g1+r3>mp|{$z-xrmjk&ekW|fq2&$u22@GvdyS`$!ToPh#0WL<^BBA>X zWV98N&DqYczL#jJ@iL=ICSWz?sgTkts(!01T8})$8y=O{YKUejsRk zOEzlbB>Pm0o_3j1A|-<%!yzeV0jqw!$yv{0hO=gOX%WR3$I;OV>+=ix?V6*TN4dMq z!e;%1?d6)q(F)g84BH-zP*yel^_tWw@@PXnFIdeT$FqW%g!^w?&|VeP%Q;0|a(T6( zPk{EM0Nc$lV&_V?>9{=KaQ5&CO;gd#O3J##7%~&FwJeTqQ8f!@Wra=9$9%(0H;j>7 zw~(U~PCxK|&VKi^oLUDdav27sa#-U?M50KB%mn-}WO##ovJH&7=;Qeue_DiI3`&mJ zBT8os*F}NVT;NVIHz~}-(wm&&n5Li*$wgY#+~WJ5m+7z8y#Doj^z(+*=?V71Lo`b$ zj_>KndR*FOq8OP{@u_Xq(774q%kQTa%kYiY7!bmcX>|~&$Mccz865@Bl(Mv-k#g<` z+W^jDDvOweoz<*T$Hibtw$6c~PBTgQn&vJ>bKq3+4ccux!Z4sAAOax-e4oYHlNiKi z$B+x~2{BpD7UK{}nF8KrrNk6-_JJ{o7{bu!08vvOiX8?t29hy^l!e?(n!2R+lkSW) zjvXYfQ&2gB$#|PUU6O^aU?)0kZy*j3Z(}2@cmqAAgl$3DJVnoIX z_Ox?gIr7jfeARY{CXx?SX29h#3A5z1!9$?aQQpFJWLFh4$`DI9)CoZUa;^6?{# zDKKS$b(Wj2yu=%y`yxZ%v+WI=u4U*8X0zP&(v+6VtB!Wl(H||DuWE)NjEmafoF(~4 z@QUh~;`bd_S6%KzbC#+qFjlBap{&n1KE28DjawA6IWt?*s}NO4nsrIcNHV#6=|!#| zJY;?T1V@2{j_YB|ylzm*nTCW!xw~VO6k`_t8=b?>#mWffh#;Ez#}djQa5XXoII@8k zlu`_JQfy@yLc(<(ZZ(8!j|9aRjv*%O=_#|%eu3>~#v5fxC`#sCpeOEb&NOBMLyBz3 zPE0k|6*5i^CPw6_VZGT2fNLTNd>>ez&kTaN{{CP(LnJZB-ADNCGKJh}KS z$d1M(iR?P5sxc4g$(cjYtbe0riLGnQ=?Ur1UE*q$Ar##+A&n~a55Pt6~i0^PkflUz;GyhfuYJ?OOwGfAtr4vFz<0zY~5Zio zvkH5hD^I$P?Yv#PrD__s{+hBX54yhcW}GE@Wp;EzNRfmm#(b8M!_ax+ z5J}z>`hoiNn9buS3^8k*Y}W%r=c${5zKVRva|S6u6BUV}-C&Kdtmi!Ukq`5Y z-~JT6zr={arby^LrLn~5v8q@dnOVo{7shk0#%5gJXmFJ!&ka zn0)F}Bp8GCiL!AR41E_Vio7niou_@{As5R9$IXm8SC_n5R-BJCG-13ZmBO{rtUsR; zt>*5qQnMErZ8RY$!@Vnt!eYzpSi}k^3dPBsH_xtf!vVQnx5kX~7&#-hYEiM-X^NpR z!b~#VPH85^?Xe5YSbWO#`OXy-vl-@Sf!w)^KR#vRG&fVgv*+E|N5HC?6m)bA#u%KP z_~a(|WuFC1knR+mMGW!wiW+TLRiVbMHtW`WAiEL*dFiLw{A@L_$a%ek+P{!G5MY{j=l|)%LO7(R0RZ&7?X!J zt73OQ8kg^XO^P@HXQ>wrNpmfVaeBX6%xSOJAcpPwn)%W3C@rx+uM>1NDJqKWodfBh z9e272JLCRzOT3QR%hb|-Xd#MFpAp!d#k6I-nU1!@&!?*EMw=_fqdcGw$Gob$kY^?GA)Yt zVfT7XdD0qH`b~>WLbXS@7#x(xqDWQvT8=!XmZgGWL1QR zg@?P{d(Y#4&i{W%(@fm-;5|7Pdk?u#i!rcmlP;N#srVlE6Ww-T(+BpqcZiE74^kFm zA!vgQbnW!8dysQAIqfO4fBl-{-L0ka6uJP%yBmJ>i$CFTa|<}a&=DS7FuuHDP@&{R zb;8gOE#0^FVao&!I#3LzNvIJD#q_SC>e^dhuxuoUfOCPk6as3~I?~EzXKG{e)I3bcmCdAe*qodB9U-%jxK~2HNkR67ij>1MR9ZK9$)VJVsy^k%mR%# z&e*+gz+B5>n@HjkRoKr;RrYs#Q}h)h5zZ+yr)&lNHmr(T02@%{q~Z}CKECGa>Y{C6 z)^{dAEt!0H%_o2QOJ0BRnyw#+ec<-hYo34hIklKPOTTGzndj6tpUo;M3aGWSE}a-6 zV%&%Jb;+4&O!%fLc6T?@4K^Jyr+S|Ao^5tmdJ$_=FHX5K9!6e#@ddXxuc=yi{pyDO zs~hfK-SGLRUodC;J7cZvZ*Q4PVb((N#y{y?fZ$E*;Zm$I03$|@xtLzkSilS2)rO%en@!IlSxuxuBXgbTWFp=&FBGqZ ztusR4n6o(sF~g`XSkQ2FjsF|pV!VC~A*^`&Io7cll;9TUVbD$RjaA*Gc}_e34btq{ zsaOK6wcxHw>3aG;!1I@k(}?$;SWPLRa}HmXG-pbxq_N_Hvj&Nx;3GaL{y~r5?$9(d zm(0OknzTrBhPAceyA~`iPO#PrIgzJ{%c}>7z~L}j_hpDsjV$OwHx$!(limG zYwfs>xYj^l0`1Qwd1x8l(VtphoLvFMaw`O z%5J-1ce&&G(G}63zuvMT6yKR_{O;ic=EIRse(_5V`vd)Ui{{Gf&tI^6{E%EL!{rv= z1*V$=PCU#uT*_?*s*4o0XkMJ9``(*oQ}9BaGq&^4Tvp@ZFp8d%$@MY#$GdC0tqTEbJUd#t> z^2nGb=8`yQ;y@v3rj$fi3K!L2q~#t726365lR~u!a&E9&5hZJ;^PbzROmilAVShU! z74D9iSBKexV1$DfLZ0mYA$XK6CQw)xm_dc8fELs_wm53dj5#p_N9w9x>&0fX6jhGJ z*8lkIj*=?fIP>n)hZY@+KrjNQoEaUDBWb}YMl3f>HE^cLuNe`$d zD&zjZbR0pIe~*rDQEx8s11e$52I8eu}THsV_C{yHBy z-0jIZk!yomwQ+dbb=FEtgSnc+)ujvT>|e_w7RRuB&eg^(fvp%?Z61C}$GNpDl>9DFvrHI`od!H6lZnp!Qp<}Zh=;H}{*3%naH%HaVqj#=3 z-0a!ExaIcsE&T^OuHSuv=NV<1teb1QLt@0G%CtWchYcJK)LIC`K%JZDq6aOeaTR>P ziN|{w=foEuKf^UcHqJBMZeYF}p_X=N-Ks^j+(%WL9kR5!7p1{(%6OPK-W`eS+-kUa z`HGtt#w5-n_!g~elMfFf_-aF5mm;FE`cDR2Szs%397`5Z)Qa7G=XiL{Bpz)K4VN1(YvpR&G42yuszFjMLalf*l~FTWoYhNwSog8t40KQ5p}hY!reWLE zTpPrwi+gQbsRc+eSj1^EEzPX7jvz#EEYQ$-+vyq4;_Ov*Iai{ma-dpKefQ08Fg$-r zo<_V6XssM-ZP72L!rXbPgW}oi4Uq+M1DXRgMO-I# zc%v8cJQAhy>htHsJ`%f#&KYVpn9fJKJ~9VSo)RHOBpM;K+in?;6Fx+IjJObp!8k}M zcxu9&Od}MckWY&354G>VXM8x+Ri6 zMI0+6K-1K55$7u1relvOf!@Bps%>Rj<*LMf9)wHXLQul!2z^QUtBs(wBgcbP~6J)FSXkJD<+j* zOIbH?+tN)@*PO(J4Kj+((cy6oBgty2#kxdJYHV;T^_v>+>^v1HB@wEpYBp!2%G@O0 z!?s7JLKR^@CTgxLbA1*C?~tmDB@x?L)byVt zBsB*l4w4!}xpT$?n&*r@OI%+Ke7d(*;Si#A1&JvYq`Gu5Srb8V4y{7*5P$32Oz%7; ziEkNz$;yDOmAIvr;Z}VnfpzlbiL`ctHogQ`tp?|eGti)!1<(|wNuMt;u`pj=vw3vQ z>rXzRcaEtT>%POL1BL)`aFkj(jFl{od>nB@hd$cj0^r*Ks63+m0I){Q!8w96oWJ2t zM5j!7vIdq8y1rv7%FW@(?%@S4M5b{9Fs191z+v?b?@bLslv*<>r53!H^a%^e*n6gF zUN9jRH=xD3E$1dLb8cHyEg)Hph>!{(001BWNkl#6A9t$hUfzLEYI3w$sW#AxpkfH2WY1ouC&%^ zX>$oUNd$;6XDhbFU`5ATE75y4y8!{F**20mPxPLLg*ZE({ugkAu-xOo3p^J zMG1BYEeNr#;Ct&X>-!Gh2UOwJv**0`{)ZgK%yzeBxVQju>|eYj%@c9AC3sJoEy|k4 znc=|}T7;uw`c0^k<^&?^keyr%`lvba>e(0UuC6%FnWf!xiErFldSA4#cvQ8-3x^pm zs!5YfDc@V673CG7G>E9G8qrQ1Neps{6{H$8kkwRiJywh8Tc7*U39;)qj3YyHV4X9m z3=wccPnZ)fE3-GX+QTu^x0`QKov;a!I?h%wtxd7k30*C#&eXC#Rl$j6FFnvnAk~>e zIx>hAkF{2U2mz}{DF(4Q@0qL3ml;Yimz4H{r zQ)*e)q%`?+Fk!?ln4t}!Vcf0b>O7ygAH|+p&F|~Oon;>Fy5)PfM93d7|U+cA+FX1^5smo{EKy>WCt z5}fDi$-B(ck>}4|pw7_^k=@0Po7+9&J#$LL%PXdrFW6mOGL930jt~RM8^0+}6QW8C zk^Lc2l67w7lr1Q$8Rvv~9M}6$)#`vgF6HXRyJ&R=S%Sr?##?h|PIx){oZ!Ue9y>29 z#O`1<{G5IMrJiB@oU_`>`t$n_Te9V^zrDxXb0Bix!=6&ag)C!>u@=mi?BhHIIs4YF z3%=l$aF{Y(3>LwOvh5@L;|%SPq+FP$#BMuS@l2uXJf${KMDGYOQi@V*B6!Ecs|!MK z+%I{oN8wA0sj7r-L-daAx3)OvxI2#AeDR8uGB+<@@cffc4gLs$VK-3ofjmxZ9$zu< zjqw{>)a$*Yb9V1a^5mRa5Tl5wy|)mk$3&@0K1|%E=fu88w28)5MYBO#+M-S`zBw1y z>QQ>?(rE`swXExMQth#lV*AaezN;KHBL=GD)#O9ADhz8{Rmhq6_xD|oR?qBtSZWJFXs zN?|JwRLmKOV{(zGbHl`2M(j)?gjxvMJZ%(5&_Zo>7jviuYNA&w9^VSgBB*zCA;LTF zStQ$PPeMH#z9ekAz|eWRHkEVP`-^k1HzO;Iy9U4Oc{v&ArFB;qgQ!a+b~27S3Jfo@F)`E(XazR5N=fbWJOsXcd`T9uMdh}SJJJ3}-$HwiV)gaH$ zh`qa7GJUt<)qVsV>H|+6Uoq#*xZhJtVRNw~cAh!eoE{fD%He2EBh83&bekS0o-&Ud zjx*C?Buyi}>nJ%hYz8zZy!WJWrnYu@^NmY@b_!?BsJFbJtxpV=-P-WFHKAD@fvt_U z=7u*MfGng0Rz>eO)xqU_QO~T5{djRy_n&_okGEJvhXt^LlXpIO;nTnM(l;LGzT_O< zstSiWvp>!!ra4%lt`AlNkwy~Kr6d3R-L%bAEYi%mAXKg{x0ZRxn@hI*{@Ls3@;bI5 ziv(N@JbL$C9z59b;QE5;c;x!g6_1`=F>E^0@xXX{zy*(JZSxsg*G&vC&lcS-V{p4@ zT!Z$w~A2c;%bneb|LmmrQ^?8(jsq=m~1%J$;a*4bozYO&6{Wjw*D`22<;Y0oWi z$a-ElwR)a2me+`Q2?)+IM^=X<_x3FaDfYx`8<||X&g9b7^uUfl@PScnym4q`N-YV} z1ZhT9sAEBI_g3(Caxcn$^Yc_3cl$ku!-13&-KHnD7Td9Dv+b@Pkcv`DqTg<cj9XiGyTN(z{yi1Yau3-&^yu|GTyqmpaPZe7rRx;XXIq{0yeDbZxon%W2zJ zJ=O!l!opQjQSOd&8#HwejVaMP4wDt+w4IpT1RR(8fOBoaVX4r#0o$Rc@8UYW47d-Y zwXc^$cshsDjAfvf%I4xBE<{4?xOw@CP2aKEJz$(OeJ&jC_GqefeMcUXMJPp42cfmR zs07rROooI=PPw&7T0c3CwLQA3>HLT&!-E~ADqY``rx}@N>caTV*(682)l!gi?#PnH zFQ4@ky`D$0%1OING3k&hrrujoW&mmLTf}M-tw%o~xLVmFgi_gdJzF3Y{fUF(n94CTGfApvoo`rrz2p8-P729;(kqb$*(SqW0{ z-XpWMy!*~ky~)AMFOQVHCwybcfLwbkr}whtvD2)K$C(%-^EBbR4R_;gt?zSXK2D6s z5fR7GN0N_>uWmq{o!tu6>DqRmQ#Pi&D&4RlMj=g!GL58hV%XX6wLGP@KIj@>Lv#rV zjI$(wZv@UIOthweB`aKa$r`lE>WK6t)OeN|o{$6ky{`(G4N*BSncrV;;q6W&d@By* zKlpC~pNxgm&{2E17Dg?0X?dJ`-}=V6SOFEW#ZblOi8x0W+s9iXtmdH>SY}SCb(kor zD$Z$}F#@?2)$D!2X6W#(PaHVaVeY+2d-A*q;Pgh7>LRL@IBXfV3Don+pZ$uQC$646 zBv+;DIwLfCXSl66)Bma!-*-)dA;G36^Z_>}LI|Xs2|$~%MF=f5uJ&f@Jd<9%qJQ!Z z()Dbvt{IO9=GQj_snq?5OUVvOxJP>1TS!PMSAq)v==eM?YuY0YUvVORdr8W_#DPvI;-A{WxgU&UoVjLKAe7M z`AVe0z_LhbG??V-5(!p!a3VZ#fmkw5)#`HI)``%5ze2bS5M6_1L1czvWX*H*|0GRr zpJLc;8K;S^?@=e*yt=`8&t|)&%p=GB0TIXL^%c`NGf#UPGo3B(Ds3e6bQ}r04JjLU z%1DZZ-L}JNG^K%~Fm!=AM$$MMSy-1wk_J7y`!G>aj2|Rt^;s~rX_jEE+5ozGvH|A- zr8eWXR!r6fJ+)t-QheIqI9oS4Z3|Tk*#7PRTDbIYryB9rY9L+~y&2Y zxm>s0V|RXSTc~A$wY998(XXaBuDY^KRh3O2alsk)Amz27Sdy{8oxpa8^lf<6`CD2R z|BaH^m!iQlRDdc*#>zP}&53tE{D8ms59Yu<^ndFK_9@I&`Wo)6MN5)b%?sP^PXtjOZL5n=6hgy((MrY(?mN zAh!K*oM*xiP3&--sM$Ke3MPtZ6AKFix=Nu)>!7Q4CIN#Ym({7VWJxE*)qoID%Q&NH zk_}x)nr3RP+|47G-GHP*ZbOf}7NYnygRMdEL6B5ihmj|#fDhmU>OFq9AwPafVv!DC zcmrn4hHjx&%6cEq?8`cyVA&5}^;oW7Ayjx{cP>pOvOafSFIi^EFEyV!7@tCGp~vBJ zVx7g)cnjifq^$Rl=ZyE2un9=-DR+veqB&DzX936}PqT0-T7;d{GVjt1`LNqD&57gT zNKG>_1UB0Z$NhovFk0pp0?{vXMXVC)e4rw$K|C*SUx_ppIl?$wCbQdaC`E1dOmHjIxIl>w6oecJRO>-Da>bPvA(1t;+BtKP) z)V)Vl*=+}6FudNiK|DFP;ZSOZzz4^J?a++$eJ8iP=9|gJ(u02|AB&l&e4r5@O92hwrE5mqRo)@p6Uso-OvY9+=%nx@88vGzpN8H~cBZfw~^ zZu2xMR;aG86LlI17Z>QRuzUQ3GR@pQdqzDTS0Ym=h0;Y+*gYO8DI0fV)6-vU*m}oB z@a!ie>Pc`Mb0({7LohVQK*djLmQde45CQm zSXdE0iy6HvCZAp~u|g5cNNA9YZ~LpX%qTR&xl9?%wKAp5=IWBUDZ=`;{|+Ua{JV3E zCDVIPFP7zKu|oc^>&dq>f`c~y#Mqt=9eTnyzQKO8ZH4oC+8=HI&e`PQyWmWmv85cc z23miG)8NbJX?-kEN&9vw+}^w7%*!lB9iaF?+-~VJlzGoov)x0d_z-bHkRV8OFjvz> z>jHVoIGJ%?NK+#zs-gu}q8=wn6R@d?DJ2RfdD3qO{5YAjO*6qc#&PC&x2L4U=3>Y3 zZqLQl6(uKfgR7QIqRumZh;&2GygyJH6ubl?#u~EQIvoyHU#k^grFHQMnKni^7oyij zCbWA~wcwp=HYIS}-%{p@Adet)q}e`q=bhDv?%nj}JeuQJqhfi(oaiYCIGdq&Z~fjd zKYy){w?-so~g`tFu_sKEC8UD)yg(Vf|H=Iad=}^TM1Ajtbs4S&&5r z09-Hzan07k+J(U3aI^_;eMgLeZ5N2a-OGB;-{Dt1t6%Z#^4?{M-1?q(o<1eUz=MYm z$@AyThml$;{m|ixP&LyJ9mktYEty!2FCfvAFlQpsGwuzKkHH&hswmz$=A13!3!ai} z&V#B=j;NDOc})8QHO&mykJ&uB=I~O;<4ADe`_7!tc%-M|)bgQef6J>{jI1~%E8MDb z;T+L>_KTcI%R~gr6g`d&LRT|EP1d~ERwF5yLdCmC5i4qzTwt8>s^r!MQwAEoBYZjPeK^Q4Y0oxVd2%wn#sqB@=S7?wk;*-l1ux zv_h?S0Tm&oLUq~Zw5u`xy%nR--2m^u&vVC zFT2pwSvU{8^o?szosH-FbRl}4vJrq)uL%VoaQz0UcjVe6`%%*o%NZ4`Bh_T%3u-P@ zA8=E}?Swg3a64 zGEyq*bi<@p_o_KFA4f`>dGW;;JbdR}=3;@#wc)#epgMqXOTFm)eM%ZQc`C3U`yX>9*auF>HVEQPR{K7nR^R-cENe~mH@Hq z@l@XZ;3+pRUXoKLO$n`q?d1h|R(v$&(xTvMQ{*WHzv&=Y8={Cs)3p}E+-or-MLSrI zm87sUuCtwbfWe$SvIuKHx*Zr_?Ze z)0e8Qpt9&@8HYs$@|q0_MXV!AFnRcyOovVSt61^9QW!GK(*zeA>Rbul)HFah`O{0(ASKwiVqzrWyW!4*loDFy5hy_TWT(B z9$YZzOiiXiHr?LQZ#RVC(CjIgjEwWvu;OF1;dCjp-3?TM*mahn=gK%HbK)&P9PjSv zwmZg@tpl^^cP*o=6++pJuaE#&*APC*9|5|gOGx!555r+74J@x z_D0;TO&D^4x@bTi@ey7wlDtae^&{=iA2Ih)?nG=r*2g#pj@s$zhup_mg}6S6y@sCLmoeU%;%qcL7Eb^O*(w==-TG8ceYG5C!AQPPR-d= zfoqGnYsLE(@%xTkrq%e&v;7|4Q&L^^c3J{&oS2s{Y=*(+0rBdZq%TRe;5J)AfJf1j zUcREF%)^IUo_%oxRe9%Xi)!L{Q#n*+T0|c!cueM8P^8){b5z+m6AD!4$SCR@Q_UnQ z`)Q&StDso>tr_^GRoMGr%wsj#kjWVoQN0l^y6#|0bilyjnrGJ1#4!bpQVve0`W#=tmdVyJWvdj{V#zw<7K%g4;c z+KX*(`7`HX^^lw^$HPd!8QAX+4Bh35mA`>}obRC1_G=DdaV_WB$JvfNWf!spJ8wj_ zoN#{;oAN0k7=Oie%!mDYZE#liAv&b@)T4Dk<$cCEM}OTj-b_gBSSH7FwwZP4GAa+(; z@xg9TZmQ8fc#89Q?->t!O3B1w$CQ#m$I{y9yGRV(DjyTPHJ0El0LZiHc7^B-(o6}d zijN(oD5ZGJ$N04Y#}p(y(OcVnBhp(<dr#Q^7v`ZmEUd%RU5;gV4REBv%D$8$^b zgL71=t^3MwV#H(@<|Z`f{UWl6X$4u$^b}F4v9q<>!lWjX-u2PgsYO>QgJI~{4n19H z($4pTz0=!2d+wB8o<5pA^W|Tbd%pwfJ+2DxfA~JZJ6^oFAx$$O2E;q+toSahequIu&N0@^ zT~3T8uP)d`2%D4(Al{17QVNm{(h{+DQdNuEoC|DoT??QpP3D_Il(1F+w6&3Dv{l;e zeyH>0TIleov${wGx;a70RPSwueeuj`rcjA$W0-Z*md>6@cf&IwUw;yopkEA-H z@j7Jf&|mPPKJ zi}j1sO9IOX5-a1^E)qjzyt@Oe9eY67M3c}FU+K0TWfG=2QL>_kOzv{)6bk1x;8R@> zp%0!I9KAT^c}6gy(wt`7AH@prWXEwF>4z;Tm34?zt!l7Y^RzAmw3r@$nP)B^UeI+N z`@8)rcVe1yHmcaN9*6gi5CY@=XfiTBKq^hYO(_(j_dr;)_^t(ZIcKCbp7h;@X*}YW z=81V`KJ4jtJLYMo7A5o@wN%7=yblc94SjDjh`d;>)z-j_r29*J#lVb zAgb0nYuSgIV{mSj7SCmobg+d>MQzTu(lP@xB6G@Y`>?hGE|LPZ8i%74i->D;P}7`A zsStuEcuS>J6P|jbC0P+qCBy$$iM787)rm*Mes*<0(Z17034CAs>9B zBR+V^{xDgD>Kr*gXPlG4Ho-COP3NcU!kKfR6|Nx&h!#>)8%1CnI?^=Ze6WZrc)NG= zY~;R@sd&1QVZ0^!$aoy_Qi)wes&e;wkEr6MGEbR|XgH6bMlXR|JFf-6c8YpeC**pCyT@A2CW(>NJ- z#v4Jc0@GaSBMgH_yU6XYUhv>+GXY_G(32!svw;sQF|BBm9uec`%;StsBQ=-R@S8B> zsm=DQ=HD#)>>kAN=FgVrTa(CnVeh^a`3a*(u=(vxywhV!1D#mitIh>4j&e7nvq!vT z9(0bpPn5AR#o>N#-U7p}IScJyo(kF`!mJ8-UW=Tkcv(x^-?%^dhCp66vW9vK% zZTe_KFY=6NWf(SiAMpK#s+IXL61_vz6c4-zP$3!r%6E}*&eU4Ssizw{VhBX<*5Kkx z_Gd{A(XX&afBlcQMkIVSX7*#Yv6zi;;MC-jOD)8P7fy4c6oa0Eb4Kvm zm2u8^@5xzlQkytprH^6l$};TIGpAy$d;(nz4AC_>jC;8A0twuI$Y1jOS3J~ohSqP- zU&Sy3iaO%3jOx8N-c$be?VSbe$FVk5%~ecwo||{nQ-jk_;H3trA+)XIX|Bu83tj z*(m{s@rH#Up1um98XrUebr$J|73g1P#0WU39wTc?hq?gHW|7B5`>Qz=sl{N;5b+NB zqQnZ-JL1KTC4Sp64_k`wkl2~*i4Ru4 zX(41O1+51E_~1|b>mCk%e_x$T$2-olk2fxLtA5vM|1N8j08p z7O}CgbFS7XPz8s#Jz12zH@&&A@$8?Cz$C;dFLP%)INYfJQ`)K-hBFw3-1$Xs^Jmh(%-wb4L zHAm;gxMQ7-dsa1@;JqXIj(N&V#{&;9b~y3oJXF`fWV6}Y#KHEjHX&9gFg&=lBu`=3 z^rYj_h{9FrhMqbd$=X=*T~CRD7`$<7q`|J|*5j;x1@P#%gspeHjmKLf68`avJ=T9? z*xy24n;Q=yc-!D11e;1Giro4(Xft@dEmsdV&6m#|kLxighg+$2pw9@_LQwZIE3ccwzVOikH9q1U`I9 zw;h=84uDweq&J3rDW)_!&&8sfCTpUl(gkm`PikeILr&A>sW2Umgb=}bVu++PgY(u- z>}MWaU6PA(yxS8tTONJuTiiW=2`^rd_BXhi@zq$mhct2}j_V*?#=ul6S%uvuvfDWb zJA8`N-Iej?^+0?}Vrp0sGe5s7;#0vX>@JQ7chQ z*;t&7_pQMs`!`~udnzVPKIO!P>l&mb%vw!6&;<~O1S1Q&EtvUDWc zN`5JDQR_ssYk_smPbh3V7HjCU21?6!dJ^N&y3|IN&cP*%v!7SP$E*u#2*iuXIL(Av zs9E7yP_NV&;PUd6H7VbtcVeEr_nKfra7 zX-;&}6I_6yqvS%KXS8Houql$xd*cDMuBpv~9n^yNy|w#`5W3LjtT;4SSC`@lVs#3D zP8`E_Lkva+u5HwV7h%|J+C6U0qd|1Tc8At%s=)~T)*38A*MoE9l&q6$Jep0ag?!vo zOQeKIj*%{gwM$Rh+L_H@4NCvb{|esgf5V7`X0Sbqb)+nVTfh#BMapJuy3Q6YR}(Sw zB25{!fL2N|LA+9RjUa=!7R$L*qVH^WMJYI7H&{d&gQp9AU6}hN$R(XWJ8aAOJ?m^a zXZNnJa1UqJdk1=fw$}4>7EP#ghzj|5;Nsy0htFSd`}qs5zy2O+f5f+$9HEcoX{MwC zVw?+c_On`w3t;-Z000tdNklbVNhkG%7YLHLHP8T@Z#u8CWMYjDxci$5v6f( z3~~d`$WwKNuG*b#WW+@VLfXs^MQR~p+>V5a6!zW|Sa=`RUq=tcfu_F&#>fwklnf&?{t_V2a-mhhgI%S4!;8>J? zo~SV*zGL^~UFtOP`uTHkH*790Edy^E_QS{5c< zkW&k=EC}&^N9g-DIy$wCz?@1ym=br0kq{!a8p8;OY0x3`n@Ak`v&hm4-}T=8YUf?m zI_rXO&4KhW zl4_+^Gu>AADCTj6m1rduqBmWoG#6--&@@*|Z3`r)>p0mixK@C#jh|3aam=|A1+E`# z=)zx}L7a$-=f}*9+aiT=%2aegNl;zlgC)89JW=jW)I%f?C2vf<7IvZrArt;g15CyWcdF6O3s+Vad zv|5ljr8>}}Y-0z`+c2pZ@FgI_hI+A~UhFu;h;}`b4-_%(M|ikntC_pkFHseo8W*Ma zj_q~FloApQ1OMe;e9V5>G3*{NTwNov=iz%#xq0=%Y69MrmC?#(x3xM>skSC4L)@IO z@WzN<*r_Wl-nN?RiDR(t=~FV?_P9Nof8xA#UeB*l&^a|lXj2ae4*JgHx50GCrbJ1O znhl0duV?&4pxXp;-CE(gz1U&|je}t=_f?^98gn%##^cB!Lo>LZu<7w3tQnN5u31I5 z8BpokO!12EBiaQtN0a=~YT9#MXR5okSQZq54Q2DD|K^+!y3TA-F@s%lzz0u^5$CO) zesR#^T@$`+t+z`Dsh;Xbf*`?L7u%V=SkMTY!|u>7S~k=e^|cggn#n1n*%^PWW#@~+ z%{ig^Z9d)_k?`|LdH78;{H16c;&hTeRy~J%l-l~|5o1|fksV_61|j6a&_&Z+ayD!z zx7X;rvh6&(emI+3{^rfsFa7t+w*LNMz4w!^Sjz=rzV}LJe_lCb8@DG#1Ro>Y-2)EW z8_H~hoV>SgF^7=m2?+sdPS!g+mbIL8dQ=vCS=U;~oHH>5gLu?h9mTbI(TGi9bjEVm zl1X=&u-V{H=2x$&DVg%<{xyBc_^4dI`-HnMUhwL0WX=_G;ZYxmLr?OKyQI80*dew< zzPz`kXshU|1JveGER)<=GCId%;UBF5-Pp$%&Mc$%R*8R>jp!S1T8x$CpeQ zGehicv~TnfJrW$-4Y*+SklIB`-=W(r)370R9T{nI6{jGhdOM|q-Y;`lDq5|R zbI}l3oW;_pgBUcI=46?^GhxyY17*&u^JA%%V4Zj3q;-f|z0yW!8~Q>itu|(|Eek}p zsQ-o-dGQPI+utxE;Z)#1`iF)=9&@2o=)y^gy6v6$JJjtL$IFr}&rnaMvP|)WC)tXG zF`pJ%6qCx5ZAxk?A)y(D87f-Dq>?2}S(Bp2zRsx0PJ;?1#yZ0@m>FaiGoR0QzW>7a z=kNLD{^8u$x$f(nAMWeC@B2EhD!HOPMn_&~{Yt2r>+^VQx@%vtBOFPB}9BVs-O!~`okQ<9}fuPD&CFW z?UH?~_a?NP{#rn@6Fnjj0#nzyRi~JL(}~DFI?$_5eY0)2rX(mKYm0+cm+!DqorI@( z(PmtdyAor_u)uJC_GG%FZbm*SOjciY^-=H0JY3fIEkey2E8bdS%WuU}Zbtro68n#9 zR~dIG?wV`;i5#6daeVLX?(9vk9JwzWZX328H*GCQI&;+bY_eGb|7J`3I`>R=YLZfV zvcX@n?*FUR*%z;`_s*`3ciL{=PJ5>v9g<7BSm~Ud|GaC4ZnEf4Yg0P=ls8sudt{Jj z@a017aAXrv^y~BClNTFD?rde3K3|P$&aZmyRd~*OZEp_v%mj`!&dZ<~1>o~YUQ zBF9VPFOv`|%R1nFdY++EK)7pQ>*x^!tM#W!EXbRyGql{xYFxe5Chr+>k%vQJftWc2 zFv(_^oY2>fZ-1HckzQI5L)_Cd85Ynw{_|Cav6|2Dwi5%@KMcIWB0HtN!Be5|D3Nt? zXl733mNN;S3{2%{@DD#s7_PSX)WfHS1{>|-{n{6UxI4BF`=fS7+PD3i;hv$b-B9(Q z$|@vP_QoBUy_(znPl?ZGZo0RpWoz6MHP@HBTYNJx=+iqG8Uyh^gH@yl)pO|!rf^uk zwPMHL&bcq&U|k+cyVGZpsb{a9TGaYxTxvys`Dl=1`28|Oj3Ucp&nyZoCE-T-s=rsY zY+Y+MT(CG9(PwKIKldbK_r2f(J?^X?kcVtMWXA~OcF?cHT3!n(@4BY3*||@KB0nHj zvhOB_TMt|{EovD@!r`zC>@z~T@vF4q-_ucs8_>Df!^(sHzAnjm)87V9K2*>1-citZ z{^tH<13%{ZxWX-Phn*X4eK~q?PwTx?)%vD!8radqr1vU*fvA)?Zx^Te>`1?%hDN({ zkHepyv=r8RIOC-troCP2L?^I;;6(Xnns_#$Yl;+njgyd0(h+_~46{nF^GEK|=ITJ7LiHDXObG!_k**CC7ME*P$a^Y zW;xkzkSU%v5KbQx0MOb(s7iv>7=Mnu4?&uK?=hkDIm(O{+f5)5u*(_^@#Y|Y{JV^Y z*+i(SC^4skcSgU$tK33$0K%tUb3~2R(AW@5%BUCftX*{q1O27qtf@+YM?fJgg%jE| zxkMi--4!i`r|ST*xS5nU9(rK10|NBHOnH)4!W}o0goIQwiLcxyA42RfDQ<#B%8k*v z&%E8B#i^h_XvDw`6_*v$5!CU?yPj|G*@9o7cqfiVtSX9s+toUh8!iHuJ*II@;_pWm zQN#*8twZ$^o^3jYpkh3AU`fJ2STqZD6*6E)l^Z2IwK6?jH$+_>u`3B^X0d6WwpzPv zB3T?}CsN|$0(ecdB5eI77pvw!m`d`wf9A$uQw4B;Fl=0eRR)X-5r4!qrJHGnlnlndUe+OZRZ>)I zNhuGn)aZXw0#4@=%We0&p+w3kY5z5@98yYMS|PC4PK#FB1%ipMT-l8tggckUAnM16 zr&#CyoGxO|Ek5EHQ8qcvX7l(Iza})y<9NmSa$UYiNBAL1U%ZG=#hJ8H=0)5 zw48G%sKSvFt3ZjJW^A{3j-wSLrK741hcr=8Cc6?r$u2oCF(*hYGf+b#u9qoV<4rKP&BcuO)9*``7#oNp5|zNsViI{OWNPt) z;l8{PN>e+QCRiD>W(sjiWyJCAzGtF-KMUn`0*$n({d8>1luWk#=M7JsZxjO(FtVtv zGw>T_2u*XdH}$+Fh8~{}fihOBe`Tz28}0Yql#tNik2XLo8A~HUGPcY3N1Q2P)<)i( zB)NwMTcv{Kg@tmwP&!y)oB~J0CSz&PL~~FLoW`1fy|>^t@h0gRn$`p-41frnD8Xcie?e=zUye} zEnLt(H558H{3xHCLV++`em_9sj&WkRz*(y3$go4yMpxl8;Q6XucdkJ4g(SxWU$+Nc z@ZxE;^tI^d= z8k{OTE}A8wXp>nyE;?qxKKR^+mSP}^LK3xQC6YqvI0Utz;Wz}YN&cnyE%yV>G|$FY zG0XRhv`)L%i_VXe!A@zla0H5Kw;_4WYIi_MP;riZ$3uN(c?&Tb=HDV8r+2WeqwsqM ze#@?nW=Oewlk=bIS~Pc-QPp=wh5D6vM+{&*?cA9|;UZBhz50bT`^I3Uj&AQlZ?8mB zLrFrz*iksEW%0rSa}*+XU;YAo$&b2{!u&Ogukbdl99d*@)};BC-AzB=u@+nAdKLo! zj9#*>k7;;CrtL3EL}XY7n<5yl=#fd`#GB2zqqhMz0<0XIi_I>pxzCOS7(ZmbIVpT0 z#D1A`9WbXD?-_st&`aa MCs)U^!x!%S2j29>$^ZZW literal 0 HcmV?d00001 diff --git a/src/content/demo/cropping-controls/index.mdx b/src/content/demo/cropping-controls/index.mdx index 996e3de0..757ed193 100644 --- a/src/content/demo/cropping-controls/index.mdx +++ b/src/content/demo/cropping-controls/index.mdx @@ -2,7 +2,7 @@ date: '2026-07-29' title: 'Cropping controls' description: 'Interactive image cropping with the fabric/extensions cropping controls' -thumbnail: 'cropping-controls.jpg' +thumbnail: 'cropping-controls.png' tags: ['cropping', 'controls', 'image', 'extensions'] --- diff --git a/src/content/demo/linear-gradient-controls/code.js b/src/content/demo/linear-gradient-controls/code.js new file mode 100644 index 00000000..aac032f6 --- /dev/null +++ b/src/content/demo/linear-gradient-controls/code.js @@ -0,0 +1,45 @@ +const canvas = new fabric.Canvas(canvasEl, { + backgroundColor: '#f5f5f5', +}); + +// import { createLinearGradientControls } from 'fabric/extensions'; +const { createLinearGradientControls } = extensions; + +// A plain Gradient instance. The controls are bound to this object and edit +// its `coords` and `colorStops` in place as you drag. +const gradient = new fabric.Gradient({ + type: 'linear', + coords: { x1: 40, y1: 40, x2: 360, y2: 210 }, + colorStops: [ + { offset: 0.1, color: '#7c3aed' }, + { offset: 0.4, color: '#0284c7' }, + { offset: 0.7, color: '#059669' }, + { offset: 0.9, color: '#fbbf24' }, + ], +}); + +const rect = new fabric.Rect({ + width: 400, + height: 250, + left: canvas.getWidth() / 2, + top: canvas.getHeight() / 2, + originX: 'center', + originY: 'center', + fill: gradient, + cornerColor: '#ffffff', + cornerStrokeColor: '#334155', + borderColor: '#334155', + transparentCorners: false, + cornerStyle: 'circle', +}); + +// Merge the gradient handles into the object's own controls: the two endpoints +// of the gradient vector (lgp_1, lgp_2) plus one handle per color stop +// (lgo_0 ... lgo_3). +rect.controls = { + ...rect.controls, + ...createLinearGradientControls(gradient), +}; + +canvas.add(rect); +canvas.setActiveObject(rect); diff --git a/src/content/demo/linear-gradient-controls/index.mdx b/src/content/demo/linear-gradient-controls/index.mdx new file mode 100644 index 00000000..85aad69b --- /dev/null +++ b/src/content/demo/linear-gradient-controls/index.mdx @@ -0,0 +1,33 @@ +--- +date: '2026-07-30' +title: 'Gradient controls' +description: 'Drag a linear gradient into place with interactive handles' +thumbnail: 'linear-gradient-controls.png' +tags: ['gradient', 'controls', 'extensions'] +--- + +import { CodeEditor } from '../../../components/CodeEditor'; +import code from './code?raw'; + +A gradient is normally something you configure in code and then leave alone. The +`createLinearGradientControls()` helper from `fabric/extensions` turns it into +something you can drag directly on the canvas. + +Select the rectangle and try the handles: + +- The two handles joined by a line are the **ends of the gradient vector** + (`coords.x1/y1` and `coords.x2/y2`). Drag them to aim the gradient anywhere — + the colours always run along that line. +- The four handles sitting *on* the line are the **colour stops**. Dragging one + changes its `offset`, sliding that colour along the gradient. They project onto + the vector, so they stay on the line no matter where you drop them. + +The object's own corner handles still work, and the gradient handles follow along +when you move, scale or rotate it. + + + + + +For the gradient object itself — linear versus radial, coordinates and units — +see the [using gradients](/docs/using-gradients) guide. diff --git a/src/content/demo/linear-gradient-controls/linear-gradient-controls.png b/src/content/demo/linear-gradient-controls/linear-gradient-controls.png new file mode 100644 index 0000000000000000000000000000000000000000..b84041df953ebc319867dcedd6ecdad1c63bc890 GIT binary patch literal 22526 zcmeFZcQ{;Y+c!LjPL!z8gXk?qXVhp(ltd62Lqv%#!l*-(h~7h@6Oj--N(_b(gou{t zo#?~pZ4BQUd+&Si=f0okectc?_i&6H#*wwmTGw@+zjm$&gS%SP6qhMLAP}{VwuTW1 zL=caEk&yuJ1RuG6#&hTG3jfF`d5I0CiL-oFQ#(Jht8i(eWGo+HaZ6a-D z5{QR~jaJ(fb&>F@Q=}mClbt+5l;-^hIPzx+WP;)oj&7D?$VdLS!qPm~d{6vC#9t=W^ArQMa9==W4OLF>)&xcnIO0IWf*AGfonajR>871Wj zrKL}LyWtf?tETO#MgaUccY!#RR_)a#23j>Tp1TGrWIUm=s{ij7|L>CguZzKOc=BT1 zz{Ef#`1Hutdv?Lcw8~2fWck&ib#rSzwt3VpD_XfRy?#_(jZ7!$m-oU=85!*4y2hgi zpB_fBxn#!fu}KT{(y+<1fRB4TS*m+2Z1$sR)t)4>mlfSrd29Y~D@?={)&9d=>M6?m zk$b0)>|qWL1acKO4aRbMv$%@+Gpm!(d<{V!S_}#+@Vqi2Zr9?0Qk`wDOUj<^ zauZiVX~m?sRzvpKzAxPE|4>i$bw?2tgjq{=A>t8oTo|t^j-xBc`c7TMg9L)Le~#r%KyC_5-|dA`YBy9OSn02iL!dD=k| zR|d}`aZXn%_O2e@%-A739{7yWTg|PbWV;)&IheGmQYm@>>4$rzT^O zQSR5&Pe!@3;1U<)^iOtnh%f}NTA1H#jphhF`q_JdQYx*>t8Iq>$$dOa=|u?lAwlvX zT8>C@^oz@#9v6FPP$$W7ooUtfXUX277OaYG5=Nf4BT7orTFk?%%fiNn1Ex-#y+IBQ z&m}*F#a-^zqP`{}AtpYsH8FCs?$fSV`J-n6fz1_VScP9mAbd74*1V0b;Vm`!}}`g{E>&tCTD@ zI7ZOWV0Kn%4q;Y}X!-%-1Q&E3*FzIcT!CLzT7`Q~RviWIRQQj;sP ztan6n%Qe=DM;}GtzKc{F8;EcFZRVIwm{KP`^w2SZ8@)< zX5QqC&zAhkTBO%5T$AKsF~XI>R9^U3)5?zETe19r!rsE`;qnsvsrm5|dV^{vdAepX zB|H9~U5Q?U&Esk~9KzU?oyg!f)_tSdr5^b-C4ST;AP9Or1o1|HH1pm9c5$T>Kgbdm z$VH{c@iHM(AeSj-a?O&FmNBDR^(KRVeu#(UhcVJ6vRugvcBwb%3!uWe24rasw;05d zjX3Y^&pf@()LwCSKWb4V@-ej5E8!AZh~zIdPtgMQsEd}Z3O7d@@-8aKyr%?XV>rT+ zV!?!V*;0&m?hLY)6+KYVs5JKk_j|b>$Qx;nkSu*bU-6xN6sUaHEw)R%do*dTK~=CC zZuW%P7m>#ih336-s7a!qLs&@@u!*t2u9(~rwbHf|eqcr#Oo##1CNVN0}faMYaUNAqosIOwsJ8Eshe(TV5Jj^76)$ZH+wVOxf!w&pDC zUBVs8##M?}woX*JuQ>e09vM=9Z$>viw6TR8tZcwl3o;>+zGQgxzy>3)GF2W`xR zC$1U$$+&igeVZ~KC;2Ma--1E%=z7sn*oj(m*#wL>BfCo?M)uXRu2#_utGVF)8qrvt zLduFV<^t_20oBa>X86U{tj6N6!?Hcx7jx$`Bvh zjbtQt{iX7<-!ZN5h@I=U`aA@BP|~+YLSaTp5EkMwVQe2U5>#<55ls_D;;UyBxnA5T z*f#FNRDlm%JuYSJ$n5b9$E#Zmpm^@>y1bDdeAKV@SR^`PS7r` zuElX@ro^2Utumqz&waJL0ok}S1 zwKwRJSIj*rU`bcX0@i>|VV54*utn}!3}08-glB#wr4B`2*tMN0mL~*va!hch(JEz^ zi(z+`EWA~OG&*U<<1&>B%JRGAD+zNMNuW$5ES!>55Ov_n{BgPYSkh zXKgdo(L0iqO8v@}va(m!=hyl|QRD6+fCCAU%i|}eF-*wQN!}W zg6m|xl4ep$3yUg#i-o+&dah5;5Fcu^UXYyu4MK;jGW_1j3;GD$b1^wPlT66B9qMBn zI=(Bq;K^}JkpZ^8f=T1pK|*(O6r+3aP9d9!$5?eR75*7^w0#midQZC_R z8@7_r9h}1Gp6&WpepquMEsDvUde{KPUXvaay(J<|pnb+gOIokd!y&hN^cI1QTAH64w*kttL4ZXIU`WSu`wnG*T8%4tkYReRuYI4UQ#yxP8_rMan zK>Rh4LB9OM2HmHR0Xk#~PnA)mhadKdJ{92<_E+TTu&@B8oA3kw>MtO2hU#5wt_&X1 zK{S@7fJ+V`Ik8Y&DbPt1;KhUGi3~0)7m0fLTv-yVV-!_?i%#`Pj@Ydn8L}kfoZ(sF zNC#+}XY9r*jM0BU>EjOuA#SF3eJ_0Wz^#jKVf_ZsxT;=7)5E;@K%MgRZcn~!xd5+Vcc>R<=$nT4Cl^DE?b}n-+W^74XV!egc^Ch zEsj7}Q1`*UC(#5^~-*ORP`p*d{Z;zFmIIdn?LU}AhJQPh;&mV9kjcw!;w*NAqO_(+ZFX;P`Rkb-)0LSe59kk-Wn>0H zUyo{fpI+|&#(sT6lG0XR75NUsZEe=AEDYR?Mz@ldv0=6KHD%XRX~ndvplACC3b18b zH~oWw#e2`E$^uxG{WClkg>G$qy9V#p&hTu%f2eJBXZ^d)rsSQ$*KpC0sykkEJ&!dI zmvfUB)0ycQ<=^SUvAMam~7M=j)w6O_p80}aiyvZy4qI^7rm8Z5;KT+ z?;)X>!;tqoe7&P5Yhd^zaMuT0aYJv<7P?4w0@+%87Glz`U|>Vj7j&6_2- zXTr?{Q{d!4&#r_r4q}R^3bqO9wnWMlDz&ZkN`BVujc878O)2!47w#yIfT@ZEkmAFty?Mg-JF!h*m6cK zK~ad5?SN-h$^ z_}(bO_e{DwHNS(PUohOV;1nnmEHSTHgIGU&K!4T)XfY_Ize69d5~xfInol3=YJRnR&R| zSva#C7l&Fn*l(4a-Uw+5iNqS4_^os-ii2Hc<(jMVjvqKDBq7 zNz85)W~po036K=-YYk5;#~^8(+d9M@zVZ|vph7RPZEj;=vs^Sac~$w6fzJr&Ka35; zISsp|mUU(Efr0*w4i}_oLY0bM9yn?~;nNX&xFW#*L|ubq3|NsNl4iud9Hn_5_KhDc z_3a@jURQMiOMLgdeVZE056^D)6qncS(|u~!^FEAtgMa0^b2>;?uFV5~JNt95Uvo#$ z>c^*5>#_@xSJ`hA5O5(slPBGM+I$`C+>$6q{6RY<^$!%m*HiOkl%`7X!}{e)5ul?} zSH7HnGuHv)XW$pX))Q>Ju-FqeIWG-4lH5itYG&bu-isQrmSIwTd6ID z0ry1%sLQPB4op_5wXDjDH;#y;WN#Ai*2hv;drWV`nNK&@<2F~5_GIVBrdaA-#l-79 zWJCk2iS(xjgQ-OjkBcC@fZcU`M!ni4TC zu_+|lMhg33U?5K5xBxXa%#z38IIB3;=&%e+LB8Y~yM+g+Ht&irc`wXDymv;WGoI^Q zij^;<>&O^?74rVZ3~(pr!U`W)TC7jn?@8-rkFS)p^wi%po$qb8%7m)AqFHGpDJ1>{ zcwTwkR1^9kBf(e6bs1klgI^)ex>jI}9Lw{s68*dBOUi7`2L~{^69i13Q~465vx{=Z*5+9|R|0!&Y5c=u zWEh-Zr2GFLSKS+en`D*Il4wvQxR9pRnTzU360O+!bD3`XD`cI_g9-2wM-v~X+3Ftx z2NB3=cQHKJ!{Ej<3>{U|*O?$gPiH{L39vhA_;!9{6 zi!$QhM-0R<1{h#KdH{%{$nE5!0GXECfAs1O*8C0vH9C@*=&xw`rDj(~6?=iLV?a?9l10^l8&7lc2g=lnax(r5Ybb>D$?$de2-lZCa*Y2-ag_Vv>u z-SDv_0nJn`aYp4U50aI=ul&D4X>^6tDfJ~f2fK&?rIoDDODclgjHnO4?%#L}!iy5A z(CgG5i#=L;dLj=WK9sWC@P7pVaigKpO^AesB~(v2kfaB9>{7SSOeE!?762^7CkR8z zH3HSdlRi77gcC2H=h+4cXc5UFj@t!V3()YW`=5i*7>`oU+^hnvo;gjc}#UEo~9f4mijn{e^ z-(JzmhSZ6EvRf~zqV#DBh9+_tvx@t3qHcaxeGp!FVweK}>YGDDO=H9Ht`+Oy&;npX z_7L92l?Jb|FIsXjyhI&C-f-IA#^0U1GBA5b?R2zpwS;BBk2U*t-)6nqYplWQ6{&%Q zie+>=P^VUfGl$j=iRGA&%)9M$g*WDA;`UI}oKM@k!8h{ruMd_KaAlfyj%rF<0;n~_ zo~#4ESO^5sk!mY?YC^LH$5u#@t+e!j$&2r0ai!bCWEAS&nd%(qNh~C6{O#|KtN1l+ zxFqvz10oSY^4-unR~;*Iu`w^L6#W7JV{o$mFJWTKgy@pG}`@*1bm;(G+E7K?Q!H8VH!8ylT>aU(Ks;`>? ztJj7_p(_Hyvg1#fXGL#)7KyrbH$JHEB_uS>G%5rMI104%m%5r*XGC%uU z|Dc8AVBl2z?4r7(ISp)=7qbS-WM!oXDU-X|vcU^^NeYO4)G*eq}tsyzOb+ z3^IC^$W_Co;HL`}5Wh-(?l#J*xeiZM_sNu%%e>la0Wd`TaF%%N3N@E|+PP zUeg#??dgF*^dwT1iSN~LHF-}k6jgyvaC6(Y=?6XO5BeJ#qG2{73^n_Anwb7Xg~M|7 zWz#9Xq^53}>a|3-AJyud*9V4z?3C{cZXGdfTRU7X?Tayx5ttLvdz__UX@eKH7Y53E zp&z9OZb73ml!SUHcPJ?e00=+H;&`2+zua8bgjS%h%R*};5;)nPB`xIyZnDZ@c|7@; zVD`JMydknsIE2uMAh~ikY5T<&iQ2hzsCit6En3AcJT5Nt7b*CQoxcBm@T8$h_Cf9d zfZ!IHw<*ty+`hSHGfn@?HV!L|m2h0?^A5D8&_vPKJobW4!pK2Pmnc=G$}+%Kk3G17 z&6LAlkX-{&=FF_%m~QY=I+ZIVZoI6N;WxE$h*@cMANl9+aO6=AQ5sA2h7RJ1~Jiby7hB1t84;7VJxDm_teq=vJ*Z7(B zbxos3y7!OC$rG>2!n}^WS64C*w~aCLAML!FcN8;xe8Cgg`9}BSU+_0)@}kVU{0MQ% zwKtAWEC0PF4s9yjI}tR%D!cn-9dl5Pvs&M8u<+3+%oV2>khq zT}KbY>A|qM8!oW44aJX;EDsbbt#^{#sCSk?gPZyr++4cFD+$a~lvp*?WnTx<;V|?Z1V7@uB!&8%{pV_!l=t-cXC! zJi!aEc;ME@A}3opoe~28HfcoWF3RBOyjH(nO4I~6?^dWLFE_*Jj!Nxo_`~sg-kTL- zbtmS>&ci8f_5f`zYqy#o;v<+Mpw#f*mfnw9cCMIC$zTOo(XiM# zUil(qw?aDS8PdWUIU{-)wu`N1lXn~M9iC?cKZ;6m9IrUw+&i4D_IrFRv)}%$@v_>v zyj8>()*$!|(4a;zT{r$gSq*JD%wF_SsCxp;Lt?ioRFi^_B}32Rm^`C*JO+B~<7`MN zjTnH(N;7R zP*c=_ssg}C{VNRd*Lb4Tq-C+WGmk0?xY{76bAyOYF7U%J*U4I@wc6*FsBgC>&dzSl zBA78@s<>6rN=mS3DBvHdee4vECUi~-SPq5;nX>BahpQ1a7D%@34_YLTV1%L1C`&z- zy@H6x-}2E>XtR<{wWTxnFfR2s7I6K9z$uzP4a4RpFb(0@tg+D8yIgkc)e2el&Z4D? z)`F{Rir8w_&i{c6Cj%63YW>}JLN(`G(Wo2@%!Y{s%0ned5i*c9V?8jI`pQ5>_qMd` z5}|aSrmAw8IPQ1p!V}Q;Us(XiOMvN`1f)(6WT65AM_+lkKx2_jO+6oty^l)px3*bO(y zE0NW4tX3rux;ch8x$%H@X2cG1Xsy)|7}VogfT&2X%J|Nl}}%MHcQOx@-k?dXzyF+By|NxU>)tY5TWTQHd#V zs?nqYiB9pp{uES*giE_nEi#G}IziP-)Z~WZKG`#$cb}Can)UI4#wc_LkKXH(SW)=a zt#hupUEw3H|O0(zA0~K&}C(xOwIh8@c!MlHpzme2r+Fupl4zx$j#3!dYK^i zTNbHW0oVAfQX&-bB|}QnU)=e?s73WiYbC;3!q^=-pDyqCS+MFm!!cXh&3n_%+-q#G?Y( zS;Mxw=M~H}QEjR$nMM(}D1E!pgZ%xOv(gyCNOr0Gh4;}*^21}HRzoOhi-Zq6;eXZX zq}II#C_}7~B8L=KL1B^rWXv^CiH!bJse3@t)O5xE_=TldcJH{S1nz^L3jq=|N|P3L zZP`T6j{^}~Kp=oYB7OsfXp|zXBp|6QY^3)U(2xli zIDzBS=L9jl$$JfdcW^W#Lb~LpBOD0%D*g`zF9j+hT{{bgBM6sp&sbmk*HPw^9-v&2 zvLtcvr|kRV`BIYL6o{E%en|G8nm?>t8ryen;sL#wpK4n^+=bK>FZAJc`9zI=JurY* zATq)TS`A)1nfl$No&RdmMZj^^qjzuPMz1{b-=+26`8_M^ejD6yI7nU>xN&RZ^yDGh ze(eIt`=d0~@ytzhjl0n0hqWNkm@m!OeV+MptFJuEMUH)E!GMbZ+*Jiz3EfJ`4^=_- zc&`OSiT~aVHz^2Z)ut2DS|J_n1+34uWf*_zh-hVDe9+Ms%Xe?H1(Vky${Xob1mR}~ zgcAo{B)`0y89S)j8j5L9ZCX^S)@xUzvkn}o%(kvw29E{3Exr5exo6(fB@!w>j1Bs% zEWGbm1D+&4KrxJ)_!$b@A&dK3VHN;>ZK2XS+pTY!Hue_9LfT#s8u9(6Pc~zSG(6r4 zvo6?xG160O*y$fvvw?2_6yL>V*= z{;}IV6}Z@Y0TlfMx;|p#B*AY>g9X_W)%n5KLHE1}mNi>?xgsoh$s z5*x^EpYlGFdW_+!^9|B8-L^ za|&|D{sS&{4PkVBC88{(IDIFiWFhtSOQ)>%m}N4Y@|c3WTQAXd5GXav=ZZM^xvYa? zzaAtTiy#%N$%Yi2t8!gW*i_V7F9^ne+gzpGL#j7g$(P-cqmxbgGNy;hNV{SN-#rf`MA*p}H=SgRg1EqYqqG@LCfka^8~ z3{$PcNy zhWIvmGb(udFXeB{_z81A4t!+vNsFvyTKvz#tviSj z-aR8a(5Nu5BjDi~ctX&1`mo)SYl?vBKnFH>u{;Yv>ld!ar#;tS5kS7=&LaJ~hGNOc zKe-lhp0%hpxLnI`w?qYnyLM%T?tC00@t0lI23};=Ij$SaUrQt!!|@jclX-(Adoqw_ z;@JtyBkvhE|9~Mi#YX>-dn;NfmSy9SCtz_k8`XDZ`*{pgE$@W2cz{Som}FWN$R<$C zxIGtfOPhsi|6RB4e!_1n68aDsB6W5AhyvRREY+P7IIh8ImNehuiqlWb$+r$mNYw{5@*#>a}fKLXaOj{hnTB@++>Jnx$n3_`ep43OaocYNlUE0{|<^Uw9(JwB0)0j zd~b^TO6#8u{lXePeRi!hyP9l#Twcoamt})jCwUrt`^EBbF;j(Ri}c~z-QtbYD5IXtr-Y;`T^H~0Hp{05ztJAAt?LQefkD4wnf;F@l1Qdv)BjWFF^hJokwHcwffcaKu*{xcM*&iwwP#P(J;;Xz`+GgRs`-R2D4;P3gTEQ z1qz^vlQTft<3$iOxUA?%2#CV*QkXW(q_=E~kCSdLCswB&7Ms z?(!~jE`+{=zWvgG=6w!VlivYG+@}oIifQ9nz~?luWggA0TH*+)k{B_tVa^k*J9jD0 zo#6A@`ew0k@2~h;{(5QtV(i_C{cSb&?dECVoCp1dO&4p~{kRvQ&*YWmeCyg@FQ#oj z|GU;2*$^1_W4bP(eSj)UA;?YgJ4cA5Q^kNd^1(5=EpynPo`_*A;0+@+Xu9qno7L>` zKH4laaa(Pbcs%=lokhk{=42(~(iYl>t0Pnu$G)C^Vq&@C==*7u2@C0bLx+VhGQ+`F ziyC$>F=p@%YZH!YYTqDi>Vh8*9L=0Kar)jMF;n5NR~n4lBEszy4_R-!X0`40B4gK` zInv~xu~=Z|1f&AGW|xNzQd$4VodgvN-imN&hNIC!0US0%bP2>jS?hg4nAdVumQ=Hq z8Ej5az-7kZU;S@|6W3?W1lYAw#}LnVMu#hodXlH9fv8>!Xz=CUR^#yXI9StjCh_bW zoL-ag`~d1WYFZKA&QpU|xM**|Fdl;qRRBcQi>iqISuS;JvywR2mK-r34ODL2_gfLD z^Rn*AVps~p>u+l&L!~^3K0D7!gIlCv;tIl&fSl=xddgv?GvU}%WTBMZItdl#XQdphwtBlEidQKOI_MTSgX{m$?o?(~DVGRhOdmjc0; zm`{#0KTY*VcluGa>oLPAkf&cGScVFP4r2Cx;XfKT0C#MLa=T=o566e9?i)@I@zn`6 zZ>(KqpyfA)9`{czeE%b9_VbC!)!biCm~XwP=~8~)BBAmrnhzTycZl8GT1JRSZVkuH z)|gCbyJ9mXne>{TE4#=omfxc!rGIH&@Qqd`u~Da3$MoQzxh|hrgE- zD4-C{{ws%TO`IYG)Z>;&k;jz88Y;~9?*JYX=JX%dGr9^eIIaF+r|5#e*En|&>;FJ~ zj5{T!lyPkvAwbM`Rw=)DldW`#lHPR$N}u*TXrVx-07@^$C+>Lc93Un1(!MP9t}FWAF9XA9Wz_B@7H+Up0smq@ajKG zgAa7{mF23==M)PTK>?<4>E$OulHtcdVKflrX2svtJxXOY*ijd{llwACYLq6#9z=o2 zJA6fGOCMR+^7DZp)z>drW($sw;wR|6+VW}KS$H;biwRJRpbEQ|qIHK?9!YPhj5uQf z7QZ=Y$e=fk5!U@HS$NLwAuwNZm$Qs#`aPvps`m$jUogxo+wA$25-?Vp-qAO)@BD1t1pypY{!B_%dG7eG^UwDxdpHxSQ=ZW=&%~yLg9X zJP?$1vil{?XFp8Va%Lv2sXp@Ysa^Wy-7$e)byU2B1kg8nbL=Sb@rGbWnMJhDUjaEA zAm2b4@Ic@Xsc=c6X$Gwh>mFcKzqNVtHbwRXMl*BFY-ie8|KehLCgoz_yS&OZWl3U-Ive)sknWL-5F(mu?r7#x$2SIWN5 zHvmGsT1AxL^fTdo><@{}9U15yVA~#&i5{MqxQ(iY=eFOIrNaw|FKcTaCgA&Bk3^f<(bQ`f zA6f|lC2;bh@08xc8q8)P3((~alcz?? zFA6AagT(z8>44?RkrciW5txDHS9I%=V;Mq}0T{vx0YHaH)woNv5QCclT5ZDWfh!@c zkS1Zj#FO$~@vlc=>s@&~nc>Uf&-pu4$|#zcSTuDuJFoP0>`V{Ar=qk{#lF6qo{AY? zY6_|;6@T>kti|*sY|ZU^!o6$baLS!QQ7YgJ=oNQDAm+#w;FW8^8&M@@wy)lk9GsU^ z!P-r8sps_PS!d6T$H>nVE5|yDcY_W$gl5 z>xHoPEAo}oj6zIGy7&w7f2d6q2o)$fu9SkAAN(@F@@QYI&TWw@WB)78v~EE?dL7K7 z@4xz3ap#T1Y|smJ>v4$yqzFPZ2v?e@3V|sY+%0O_wf>d`Ob&R3>zX@p8FEOzeA<1~BG`>awkM@Y(4#cBy$_{e8`M`)*ihx%$dI4R%^x z=h`B2*n`Y!iQRwDOyr0Q$WCAd1890JT^Vvw3;fOvN4Wz^Xuv zl7DDlhjLc&>%d0(vMj~=3LrnH8A?zMDgyA-m~l(@E`oUfW7z( zh)r#^Wo&GB@XOwB2M}cXXts80ZS&iAHmh|y=GOy}1gRX}RKA$y=0l|OS58W=yr<@* z4)y-Oo*&td4Miw1-LRg3*5*FdDoiH6uZa}t&jL7VibfnQt(-kYU`B&rz{UxiYVs%j0Kn zCIXgzq~W^N@vk~;Pdfg+U$xJzFo9?dh*nqKxX}IBYZOFS$lep*Tja$V1zalulCtV_ z8N|qE+2oXILb6(=2^uNy{srOCfW8(8es4W68Q21d8q!TbSuCLC2RlK%ciP*l4-c(j z^XQ68?jsH~=Cw{8?}!ds8^KM))O&kh+_mmxg|=SI3KA(rFuFEYT|gkmUoM9D>a4K? z3;B_DgXH+1e0csfoN#H!YZBNof`<-&NRLK;##t7I@S#o{Wu;;Hrf9wam+w54_ z+3LF18yhUVnPQHb6kw#f}s-lS9=06p|@xUyw+dx=m0E~XXb`%|^hZKPfn-9us31J}- zqx3>z5sdLJVmPwAnTN*}U%oRhF{dbnRZ&9s_0qB*2!_Cg7E__Jan0VTnSgz}YVD3L z9<8vG05vNe^s4x2X)XKzD?1aFtw@wTex~tj@SFKlN`O#KCJavEN-KAG3Iq}e|8#tr zO^?Y*jJds5v}zpBCj){khm{euOUyMu62d@G-3+4o!h+FWOfoWYCdnfwj`qDaR-S^n z;Lf~Xem;!)e+kuGT#frKAm@>s6R}N3*iF1NX4=tr3kCjw&1{4{6{WeNyF23N$NW&V>iJ9AGrPrT&a|r(0JiuPE4Vbwtp^I^y6!=C@I7Ol)wxJ_7Yi6ird z-@MexUgPND*l!Ohn_q@?zvDgJR+s19rW>Yb_NvRChA3en38E2Q_!a^%LFdXSH>Uiq ztejmDS@3^mnZ=BmELUOGULC&v*s$!mV>?W9movt?4BqNCp3Jt{n1qZ;z#TA^TG9U{ z5~kcv{pI=cW<0E|%^ zaOyT1!V$L_wKkI!|i5zt_Qx1i&Nqk0}c3U7_eCK0PQ@5kDi}9NLe;K z#CB0BxJ3rOBEYo^l)>}dw8}n_ZEk3n#BAD$#Xf*vox)H)zmf#1%QQjdngRiR8> z%QJ=C5Ab6G!=!--Jap`D+N@lM**w#)9sd{)Hz}?W?cfMRkRNn6T{3?t{rGotMcwId zuGzf&QmwQ11eyRR;AFE{0(8zUK0`!#QN=%*D{G3_U)-+u;YHw9f|>X}Aq8 zDZ75ELpb8G;W!`Q0Rbe_Sc3e!N>TZ4e&cuMMFya<{S6zd1d7q>%qN6jyR<98vLt8U zD(K*vz~D#Z7E@2_zS4!ti+7l4fq0*P%O< zL!AYyfa4oP!%fVUk3q=51+4c>o2yl8tTD?7OdJ#Se5?rU}HPd;mjNNRf7empgxCX0per#>OqX8d!!>W^Tw+&zlO;4zoyUIo*MHj^mJjMgjkDE*>32h$~in*#M1ndi@>cem&g8qKK$W%#RA0apcntJ!MfWBS~t{ zh}qGH(~_dGLce^o)bPrwlTMcTJ}dJ+qDT~2d#|W^e0WxR{(HF&&wH5;TYnJCr_MYT zVIcYBqCQFVw}A{rR^M#svBFyhz>PBY>$rF_{{ykLOlk5Mw@AD^DNEMDc|z?!7wRYV zr1?dHqZA-@HR5m5`(0j}OYoUSltiZs97s=55Fjr=jd$+-8{P!ct@r(qA~f5OFBUAn z!`ud41RzW^0{|zkfo=WLGnoxDDa`${r%tts1m8U!Q4(L``3eFtr{kXsAUoIRn*Y%~ zN0sFyL-N}`K=222UI&2~p?CvYdQ?+33Q%ngju|tu(c$fYd;N<0#;uF7K+J8vc=WX} zrQ{yM2xA#}o<``#l^U7iTBf&Bmn2XMdK+3MMMPM1fc*QrJ{RUYpfBskUS^mAU1l#y zk)V?p-6e|CAhsJvqfT=>%As@qfNHJ=dVJ(iW84KOJ*BlRfD6ZD00ap>mOc>mJuvY; z4T~ywncVqM;*3gjPn}(k!(9vs=S;=21KUTY^ElwXH$JZjV808MQU7p9Mh_6zCJ1gl zx$r0a`;RDK$1jYo1YR-wg~$Yk&eT!d>)!?Bw@a^c_SoN4LNUX`F%CK z;^|SZ;m;#FhgoYAMEIK>604p$xObo)ks^qfq}r;BVBBpgfvvyR#3WiGJNYfJJq-20 zvpYv?w@B@5yb`J$nTQvBmcP6GSHMW82X-ec5k4HZ`6G#AQm~ION{t4>XhjXl3Y=2} zS7Y~1E`EX@`8i={Bu4zu3oMnrM=UqCJw^gXK8_quNtAn^-a9;P^|NZ-_kFtYeMrV? z^!Vz@(Vptz*3xV1X&yv3lu3v!LfFbC#L`_Ce01}|mjBe<=WemWI&U;ol_eZ$Dh ziyTOAh!4$9N&$|r4YK&$k*4i&bHYLj2UC)>>{mQEs0O4rz z@ALr$F*6_39$nF4)qWjx-x5HrY}J78!q-XT;g!quXM{&l1N=_J*m*@D>kJr-Wq>Ak zqYTD?y(Tc}dDhXYb_^*QPZWQ7{=9)&1-xzBJXX@^1ZRCm#iysjO>##{J2JQ2|4-g7 zCGp>cv6Bg;^)zyfJ0^e`nL#|&IfG~#;&j!JB2|*#_{)J)_>3YMp@B)Wg+@cuY(g{< z^zpiY0gMmY(K_jQZj`{i}9b_(xN&ksb0M7QOuk ze$3DVzq0y%7oXLVr*s4I;*X*dx(vH2p4q-zgLzKC#|c0O6JVls4yzY{ciXH)13X^k zw$cLoFSHKBbRax$Isr(C<_r6Q2PX# zYi+~_B{a<@*qRDZj{PR~gtS4aM{RQEXZ*t*y>}0$Dc_CdpNep6UNIyzA}`?Db1B9f%vx6^SBJEd z|D3`5kD&E;C2=6DY!>toFCuFkAR@;I-cK{cpFNs>Dek{@NVC;8555t&1S!!jIT1Rc z$=3L>T-M6AP5vvoo??pA?n*VM$$Wq;j0fgYMKaaW_g4u7m*k0KOmAQv z&N@|Ib)3TvT+&Gn`YM6@Jxu#`Cn(@Qif=kn9`UVLe<8JvOYiTjcU`qHB$fhQ3OL(< z?6gou$MDkaWjVJpmHg|AEj z+^9qP1CX`tG22yMVneoSgzwEvWylMzA|!3~AB={J9}+LW|Az|=DCp-y71czdrai(e z$V(p&0z-a<>*v}2HhwBKilsd463HAMg*eded(sID75M{b89-}?#vEIsnp!bZxQ zzu7``f15qiP7VU8S&9N-fpZ_In{v$zv5LN8r^Q3z08DhJNC7HB*k*TO)TL!(YiGa` zg)wUG0R-(iDxR@z=HYGSwQsRv{2r+ol7Eco>ILpMPU_CxO9YOdjM%+|pXFC67aNUv zXxfYA5^YTZqFWoQTV5P;$#8%?)RFq`08M}d$ow38`BQ1VP9mwWrtm0GVkI*33{_@vIT|8t&Y4-zt z`R2(8hT?@B)4k-Aa@@%1y<_>VPrO$swbhWt&qOn#{1^LveAo)=I8~&?h(j6WPA6?d zwhr(0=CIrDfZ_dSl!jHO|c<%B{9 zSt4899ND4}bxJ8~nGs^_5khv8iZB?HQz?WKO?I+2mfVyW`!bVoD3i(1BFZD0F&Z+CFA99lqmGQ-sgZAJ?mAV zyBhkG)`Ob0L4cPMtw*%YrXskQ4FB+lUj1Gc2RD%t5wDPiZ2&g(ENLQ7`Leq8`~_SHP70OjftiQ ziqpl&T&KxNp7bFUGs3>6;*Z=;?db^vjZzOm0%*;-wpcwB-M%h_s`CDy#`7;mHr1MS zOQzEl>3u2_Y*QIn&_jDq<|&>Qy!~G35!h}=MnN$p{F`kZ>&sq^$F@RJwEq~Y{}h7r zOu;>T9Jn`QFP`~sTS0}Vj{mqi1Ujge{i|39Z>8UB!LoTFNe&KxsHFvJhX*%hej zF_SLuT&Iw~A@MFEomDl(PUuYwQ+N*D2?J7!0TVw)%3AFLFWq%ztcVZN$B6w?v3}yO z1rpDug#CqB^Jiay$jl6tEy=`pVwrMVJ@j?c$xvsChB)5afc9KAsw11VFIxrP$E&!Tf2Vz*%+pBHBBtP3xnB=nBLW?im zgjc@?VApho0XKoGL(gYwkGt3f5&?7V?M_-Ttk&9i^ycQkMFoSZyfbT#z(Z+BPT3Sc z`%O-w=$e@kf4=9v3@09sve24bTPrJfl9A>K0>|~z1Ubn53r4OUUinV}5zzs+os3jB z%oVRCY!GMTpcnu>#|{5jX_2y%deF4la?V}5-1p;RE^L11CYn$D=D-4pBtUc&9OS&; zj%aNdDq>^^-T>-B*CdRT0#0%TROk|w<}Q32I&8>vuCXfYZGnr1L%j5sX!*lqpwLBt zF6#VpQt9p7=&unHN06sfOHh~e=u2C`sagFqv?H^eMQLm1=9%Mf+*xx{h)KEyyt15N zZTMQs3?ZJHZ|;HWUnwh`Oq zBik=rebfZZVKxzS5t$T>$)+V@b2-yO#M9iSUkx?{hIK{^7XMmE<`CCoAk#v}Uw`bb z$rF9<+wAV;RZu@6MJ@5j-XxTjI76Ctsp@*u30cO?Iw>z11Hb6fZq{__C3KA@G@}WajKwfB(f989E$B zdpne5#KxV8Rrsr*K~6a9LV`VDytW`lg4R)i#;;EGa+o^DMRnodawzZ;-T?+N*IC$-j}Gs5$kt z`+(moeTY(r!u7^mAK>rYu`DYqbD#_^Rj%A~h1}3zR4?&SSgm>QCY2?#w-KOR#r8;8 zeT%yI$c+n+9UnM%x-J$;E_RlER=v{1R0}?alvF#OU}YgM0qf|hM&WhUQ7U8|UQ*vv z939U3qARvQJgF5&n0?>EGe5|9`A) c)7rM#U@g7p-EkNY=nFe;WNKJ&^kUS%04E28KL7v# literal 0 HcmV?d00001 diff --git a/src/content/docs/docs/using-gradients.mdx b/src/content/docs/docs/using-gradients.mdx new file mode 100644 index 00000000..e37c0075 --- /dev/null +++ b/src/content/docs/docs/using-gradients.mdx @@ -0,0 +1,119 @@ +--- +date: '2026-07-30' +title: 'Using gradients' +description: 'Linear and radial gradients in Fabric.js, and the extension that makes linear ones interactive' +sidebar: + order: 650 +--- + +import { CodeEditor } from '../../../components/CodeEditor'; +import linearCode from './using-gradients/linear.js?raw'; +import radialCode from './using-gradients/radial.js?raw'; + +## The Gradient object + +A `Gradient` is not a shape — it is a paint. You build one and hand it to an +object's `fill` or `stroke`, in place of a colour string: + +```js +rect.fill = new fabric.Gradient({ type, coords, colorStops }); +``` + +Three things define it: + +- **`type`** — `'linear'` or `'radial'`. +- **`coords`** — the geometry the gradient is painted along. What the keys mean + depends on the type, and this is the part worth getting straight. +- **`colorStops`** — an array of `{ offset, color }`, where `offset` runs from `0` + at the start of that geometry to `1` at its end. Colours interpolate between + consecutive stops. + +By default coordinates are **pixels in the object's own unscaled space**, with +`0,0` at the top-left of the object's bounding box — so for a 280×160 rect, `x` +runs `0` to `280` regardless of how the object is later scaled or rotated. Set +`gradientUnits: 'percentage'` to use `0` to `1` fractions of the object's width +and height instead. + +### Linear + +A linear gradient has a straight axis: `x1,y1` is where it starts and `x2,y2` is +where it ends. Colours run along that line, and every point off the line takes +the colour of its perpendicular projection onto it. Making the axis diagonal is +just a matter of moving one end. + + + + + +### Radial + +A radial gradient interpolates between **two circles** rather than two points, so +its `coords` carry a radius each: `x1,y1,r1` is the inner circle and `x2,y2,r2` +the outer one. Offset `0` sits on the inner circle, offset `1` on the outer. + +Giving both circles the same centre and an `r1` of `0` produces the familiar +glow spreading from a point. Offsetting the centres instead tilts the whole +thing, which is how you fake a light source coming from one side. + + + + + +## Making gradients interactive + +Everything above is static: you pick the numbers, and to change them you edit +code. Dragging a gradient around by hand is a different problem, because the +handles have to be positioned from the gradient's own coordinates while +following the object's transform and the canvas viewport. + +`fabric/extensions` provides that as a prepared control set: + +```js +import { createLinearGradientControls } from 'fabric/extensions'; +``` + +It takes the gradient instance itself — not the object — and returns controls +keyed so you can merge them into whatever the object already has: + +```js +const gradient = new fabric.Gradient({ type: 'linear', coords, colorStops }); +const rect = new fabric.Rect({ width: 400, height: 250, fill: gradient }); + +rect.controls = { + ...rect.controls, + ...createLinearGradientControls(gradient), +}; +``` + +You get one handle per moving part: + +- **`lgp_1`** and **`lgp_2`** — the two ends of the gradient axis. Dragging them + writes straight to `coords.x1/y1` and `coords.x2/y2`. `lgp_1` also draws the + line joining the pair, so the axis is visible while you work. +- **`lgo_0`, `lgo_1`, …** — one per entry in `colorStops`. Dragging one sets that + stop's `offset`. The handler projects the pointer onto the gradient axis and + clamps the result to `0`–`1`, which is why these handles slide along the line + instead of following the cursor freely. + +The controls hold a reference to the gradient you passed and mutate it in place, +marking the object dirty so it repaints. Both `gradientUnits` modes work — the +handlers divide by the object's width and height when the gradient is in +percentage mode. + +A second argument lets you pass `Control` options applied to every handle, which +is the hook for sizing or custom rendering: + +```js +createLinearGradientControls(gradient, { sizeX: 12, sizeY: 12 }); +``` + +### Current limits + +- **Linear only.** There is no radial equivalent yet, so radial gradients stay + code-configured. The extra degrees of freedom — two centres and two radii — + need a different handle design, not just a port. +- **No `gradientTransform` support.** A gradient carrying its own transform matrix + will render correctly but the handles will not line up with it. + +For a canvas to try this on, see the +[gradient controls demo](/demos/linear-gradient-controls). diff --git a/src/content/docs/docs/using-gradients/linear.js b/src/content/docs/docs/using-gradients/linear.js new file mode 100644 index 00000000..c4f1b8da --- /dev/null +++ b/src/content/docs/docs/using-gradients/linear.js @@ -0,0 +1,19 @@ +const canvas = new fabric.Canvas(canvasEl); + +const rect = new fabric.Rect({ + width: 280, + height: 160, + fill: new fabric.Gradient({ + type: 'linear', + // a horizontal axis: left edge to right edge of the 280px wide rect + coords: { x1: 0, y1: 0, x2: 280, y2: 0 }, + colorStops: [ + { offset: 0, color: '#7c3aed' }, + { offset: 0.5, color: '#0284c7' }, + { offset: 1, color: '#fbbf24' }, + ], + }), +}); + +canvas.add(rect); +canvas.centerObject(rect); diff --git a/src/content/docs/docs/using-gradients/radial.js b/src/content/docs/docs/using-gradients/radial.js new file mode 100644 index 00000000..96211dd5 --- /dev/null +++ b/src/content/docs/docs/using-gradients/radial.js @@ -0,0 +1,19 @@ +const canvas = new fabric.Canvas(canvasEl); + +const rect = new fabric.Rect({ + width: 280, + height: 160, + fill: new fabric.Gradient({ + type: 'radial', + // both circles share a centre, so the gradient spreads evenly outwards + coords: { x1: 140, y1: 80, r1: 0, x2: 140, y2: 80, r2: 150 }, + colorStops: [ + { offset: 0, color: '#fbbf24' }, + { offset: 0.5, color: '#0284c7' }, + { offset: 1, color: '#7c3aed' }, + ], + }), +}); + +canvas.add(rect); +canvas.centerObject(rect);