chore(TS): more FabricObject types #8405

ShaMan123 · 2022-10-31T02:35:33Z

Motivation

Description

More types
Left Gradient/Pattern types alone since there are open PRs for them, I don't want to create conflicts
Exposed getCanvasRetinaScaling on ObjectGeometry for ease of use

Changes

Gist

In Action

github-actions · 2022-10-31T02:41:10Z

Build Stats

file / KB (diff)	bundled	minified
fabric	1042.386 (+0.421)	311.371 (+0.121)

github-actions · 2022-10-31T02:42:32Z

Coverage after merging ts-object-patch1 into master will be

82.38%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
HEADER.js	54%	48.15%	0%	63.64%	12, 14, 14, 14, 14, 14, 16–17, 21, 21–22, 22, 22, 24, 24, 26, 28, 30–31, 77, 77, 77
src
cache.ts	97.06%	90%	100%	100%	56
canvas.class.ts	93.36%	90.22%	94.12%	95.54%	1047, 1047–1048, 1051, 1071, 1071, 1106, 1139–1140, 1168–1169, 1202, 1210, 1320–1321, 1323–1324, 1344–1345, 1506, 1511, 1521, 1525, 474–475, 480, 489, 638–640, 685–686, 735–736, 739, 741, 784–786, 828, 833–834, 862–863
config.ts	77.27%	66.67%	66.67%	84.62%	130, 138–140, 151–153
constants.ts	100%	100%	100%	100%
intersection.class.ts	100%	100%	100%	100%
pattern.class.ts	92.19%	85.71%	100%	96.30%	109, 115, 126, 135, 87
point.class.ts	100%	100%	100%	100%
shadow.class.ts	98.51%	96%	100%	100%	156
static_canvas.class.ts	89.83%	83.28%	96.70%	92.55%	1112–1113, 1113, 1113–1114, 1248, 1314–1315, 1318, 1367–1368, 1461, 1476, 1480, 1506–1507, 1536–1537, 1570–1571, 1612–1613, 1616, 1618, 1618, 1618, 1618, 1622, 1622, 1622–1624, 1646–1647, 1688–1689, 1692, 1694, 1694, 1694, 1694, 1698, 1698, 1698–1700, 1771, 1771–1772, 1830, 1832, 1832, 1832, 1832, 1832–1833, 1836–1837, 1837, 1837–1838, 1841, 1841, 1841, 1843, 1846, 1852, 1854–1855, 1855, 1855, 1858–1859, 1859, 1859, 1862, 319–320, 322–323, 325–326, 339–340, 342–343, 57, 658–661, 783, 783–784, 861
src/brushes
base_brush.class.ts	100%	100%	100%	100%
circle_brush.class.ts	1.52%	0%	0%	2%	101, 103–105, 114, 114, 114, 116, 118, 120–122, 124–127, 135, 142, 144, 24, 29–30, 38–42, 46–50, 57–60, 68–72, 74, 82, 82, 82, 82, 82–83, 85, 85, 85–88, 90, 98–99
pattern_brush.class.ts	5.26%	0%	0%	8.33%	16, 20–23, 25–26, 26, 26–29, 37–38, 40, 44, 55, 55, 55, 63–65, 65, 65, 72–73, 75–76, 76, 80
pencil_brush.class.ts	91.91%	85.42%	100%	93.64%	123–124, 153, 153–155, 277, 281, 286–287, 69–70, 85–86
spray_brush.class.ts	1.16%	0%	0%	1.56%	100–102, 104–105, 113, 113, 113, 113, 113–114, 116–117, 124–125, 127, 129–133, 142, 146–147, 147, 155, 155, 155–158, 160–163, 167–168, 170, 172–175, 178, 185–186, 188, 190–191, 193, 200–201, 203–204, 207, 207, 214, 214, 218, 23–24, 26–28, 28, 28–30, 34, 43, 50, 57, 64, 71, 78, 90–92
src/color
color.class.ts	91.67%	84.51%	100%	94.44%	325–326, 330–331, 334–335, 41, 45, 72–73, 73, 75, 75, 75–76, 78–79
color_map.ts	100%	100%	100%	100%
constants.ts	100%	100%	100%	100%
index.ts	100%	100%	100%	100%
util.ts	100%	100%	100%	100%
src/controls
actions.ts	100%	100%	100%	100%
changeWidth.ts	100%	100%	100%	100%
control.class.ts	93.98%	88.89%	90.91%	97.78%	235, 319, 319, 354
controls.render.ts	81.63%	78%	100%	84.78%	106, 111, 121, 121, 45, 50, 61, 61, 65–72, 81–82
default_controls.ts	81.82%	66.67%	100%	100%	113, 120
drag.ts	100%	100%	100%	100%
rotate.ts	20%	12.50%	50%	22.22%	45, 51, 51, 51–52, 55–57, 59, 59, 59, 59, 59–61, 61, 61–63, 65, 65, 65–67, 67, 67–68, 73, 73, 73–74, 76, 78, 80–81
scale.ts	94.41%	94.74%	100%	93.59%	129–130, 132–134, 181–183, 42
scaleSkew.ts	80.56%	66.67%	100%	92.31%	14, 28, 30, 30, 30, 32, 34
skew.ts	91.03%	79.31%	100%	97.67%	130–131, 162–163, 170, 176, 178
util.ts	100%	100%	100%	100%
wrapWithFireEvent.ts	100%	100%	100%	100%
wrapWithFixedAnchor.ts	100%	100%	100%	100%
src/filters
2d_backend.class.ts	92%	83.33%	100%	93.75%	35–36
FilterBackend.ts	88.89%	83.33%	100%	90%	11–12
WebGLProbe.ts	40.54%	40%	60%	36.36%	28–30, 30, 30–31, 33–35, 43, 46–48, 48, 48–51, 53, 58
base_filter.class.ts	22.35%	20.41%	38.10%	20%	100, 102–104, 104, 104–105, 112–114, 114, 114–115, 122–125, 125, 125–126, 132, 132, 132–135, 153, 183–188, 192–193, 193, 193–196, 196, 196, 196, 196–198, 204, 213–214, 219–223, 266–269, 285, 285, 285–286, 288, 304–306, 306, 306, 306, 306–307, 309, 311–312, 314–315, 317–319, 327–328, 33, 330, 334–336, 340, 340, 340, 344, 344, 344–345, 367, 367, 367–371, 54–55, 83–84, 86, 86, 86–87, 87, 90, 95–97, 99, 99, 99, 99, 99, 99
blendcolor_filter.class.ts	10%	4.76%	28.57%	9.72%	104, 126, 128, 128, 128–130, 135, 145–147, 155, 157–160, 162–165, 167, 167, 167, 167, 167, 167, 167, 167, 167, 167, 167, 167, 169–172, 174–177,

ShaMan123

READY

ShaMan123 · 2022-10-31T03:01:04Z

src/mixins/object_geometry.mixin.ts

@@ -602,6 +602,10 @@ export class ObjectGeometry extends ObjectOrigin {
    return this.scale(value / this.height / boundingRectFactor);
  }

+  getRetinaScaling() {
+    return this.canvas?.getRetinaScaling() || 1;


exposed this instead of having to check if canvas exists
I wonder if we should change this to
return this.canvas?.getRetinaScaling() || config.devicePixelRatio;

Should the method be protected?

src/shapes/object.class.ts

asturur · 2022-10-31T20:44:39Z

src/mixins/object_geometry.mixin.ts

+  getRetinaScaling() {
+    return this.canvas?.getRetinaScaling() || 1;
+  }


i was thinkging of this, but i don't want to do it.
There must be a way to tell TS in all those functions canvas exists, without having to runtime check it.

Like having a type in which Canvas is mandatory and TS understands that is the case.

(but at least should be called getCanvasRetinaScaling) just to be clear objects do not have their own retina scaling

Naming: good point
In half of the cases the check in needed so it seems.
We can assert Or use ! or what you suggested (need to think how)

So I will rename and we merge?

Well OK maybe if we do like I did casting this: this & Required<this, 'canvas'>

asturur · 2022-10-31T20:45:16Z

src/pattern.class.ts

@@ -144,7 +144,7 @@ export class Pattern {
   * @param {Array} [propertiesToInclude] Any properties that you might want to additionally include in the output
   * @return {object} Object representation of a pattern instance
   */
-  toObject(propertiesToInclude: (keyof this)[]) {
+  toObject(propertiesToInclude?: (keyof this)[]) {


pretty much sure will have to go back to Record<string, any> for this, but for now let's try

asturur · 2022-10-31T20:48:12Z

src/constants.ts

@@ -8,6 +8,7 @@ export const twoMathPi = Math.PI * 2;
 export const PiBy180 = Math.PI / 180;
 export const iMatrix = Object.freeze([1, 0, 0, 1, 0, 0]) as TMat2D;
 export const DEFAULT_SVG_FONT_SIZE = 16;
+export const ALIASING_LIMIT = 2;


added here but removed nowhere?

moved from Object

ShaMan123

ready

ShaMan123 added 2 commits October 31, 2022 04:34

types

ce190f3

Update object.class.ts

de52bef

ShaMan123 added 3 commits October 31, 2022 04:55

expose getRetinaScaling on FObject

5887a8a

Update CHANGELOG.md

51f46f7

Update itext_behavior.mixin.ts

7e1e193

ShaMan123 commented Oct 31, 2022

View reviewed changes

_setLineDash

9329526

ShaMan123 commented Oct 31, 2022

View reviewed changes

src/shapes/object.class.ts Show resolved Hide resolved

ShaMan123 added 3 commits October 31, 2022 05:21

arrays instead of strings

f3d1c2e

ts

3ab4c5a

fromObject

bf030b3

asturur reviewed Oct 31, 2022

View reviewed changes

asturur previously approved these changes Oct 31, 2022

View reviewed changes

getRetinaScaling => getCanvasRetinaScaling

10b55e2

ShaMan123 dismissed asturur’s stale review via 10b55e2 October 31, 2022 22:07

ShaMan123 added 4 commits November 1, 2022 00:08

Merge branch 'master' into ts-object-patch1

4c12a3e

fix merge conflict

663fe82

type

f608d45

fix leftovers

dd0b9da

ShaMan123 commented Oct 31, 2022

View reviewed changes

ShaMan123 added 3 commits November 21, 2022 16:24

checkout

44a0be5

Merge branch 'master' into ts-object-patch1

ce9f2fc

restore after updating from master

a55eaa1

ShaMan123 requested a review from asturur November 21, 2022 14:26

ShaMan123 and others added 2 commits November 21, 2022 16:36

fix types

6c6e4e2

Merge branch 'master' into ts-object-patch1

eb4e837

asturur approved these changes Nov 26, 2022

View reviewed changes

asturur merged commit 782fa19 into master Nov 26, 2022

asturur deleted the ts-object-patch1 branch November 27, 2022 00:14

frankrousseau pushed a commit to cgwire/fabric.js that referenced this pull request Jan 6, 2023

chore(TS): more FabricObject types (fabricjs#8405)

d22e985

ShaMan123 mentioned this pull request Apr 7, 2023

feat(): Video #8826

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(TS): more FabricObject types #8405

chore(TS): more FabricObject types #8405

ShaMan123 commented Oct 31, 2022 •

edited

Loading

github-actions bot commented Oct 31, 2022 •

edited

Loading

github-actions bot commented Oct 31, 2022 •

edited

Loading

ShaMan123 left a comment

ShaMan123 Oct 31, 2022

asturur Oct 31, 2022

asturur Oct 31, 2022 •

edited

Loading

ShaMan123 Oct 31, 2022 •

edited

Loading

ShaMan123 Oct 31, 2022

ShaMan123 Oct 31, 2022

ShaMan123 Oct 31, 2022

asturur Oct 31, 2022

asturur Oct 31, 2022

ShaMan123 Oct 31, 2022

ShaMan123 left a comment

chore(TS): more FabricObject types #8405

chore(TS): more FabricObject types #8405

Conversation

ShaMan123 commented Oct 31, 2022 • edited Loading

Motivation

Description

Changes

Gist

In Action

github-actions bot commented Oct 31, 2022 • edited Loading

github-actions bot commented Oct 31, 2022 • edited Loading

ShaMan123 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asturur Oct 31, 2022 • edited Loading

Choose a reason for hiding this comment

ShaMan123 Oct 31, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShaMan123 left a comment

Choose a reason for hiding this comment

ShaMan123 commented Oct 31, 2022 •

edited

Loading

github-actions bot commented Oct 31, 2022 •

edited

Loading

github-actions bot commented Oct 31, 2022 •

edited

Loading

asturur Oct 31, 2022 •

edited

Loading

ShaMan123 Oct 31, 2022 •

edited

Loading