Group

Fires

object:added

Fires

object:removed

Fires

layout:before

Fires

layout:after

Extends

• Collection<(options?) => FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, this> & FabricObject<GroupProps, SerializedGroupProps, GroupEvents, this>

Extended by

• ActiveSelection

Implements

• GroupProps

Constructors

new Group()

new Group(objects?, options?): Group

Constructor

Parameters

• objects?: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[] = []

instance objects

• options?: Partial<GroupProps> = {}

Options object

Returns

Group

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).constructor

Defined in

src/shapes/Group.ts:139

Properties

__corner?

optional __corner: string

keeps the value of the last hovered corner during mouse move. 0 is no corner, or ‘mt’, ‘ml’, ‘mtr’ etc.. It should be private, but there is no harm in using it as a read-only property. this isn’t cleaned automatically. Non selected objects may have wrong values

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).__corner

Defined in

src/shapes/Object/InteractiveObject.ts:105

---

_controlsVisibility

_controlsVisibility: Record<string, boolean>

a map of control visibility for this object. this was left when controls were introduced to not break the api too much this takes priority over the generic control visibility

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._controlsVisibility

Defined in

src/shapes/Object/InteractiveObject.ts:112

---

_objects

_objects: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[] = []

TODO

needs to end up in the constructor too

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._objects

Defined in

src/Collection.ts:21

---

_scaling?

optional _scaling: boolean

A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. This is an edge case and is used twice in all codebase. Probably added to keep track of some performance issues

TODO

use git blame to investigate why it was added DON’T USE IT. WE WILL TRY TO REMOVE IT

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._scaling

Defined in

src/shapes/Object/InteractiveObject.ts:134

---

aCoords

aCoords: TCornerPoint

Describe object’s corner position in scene coordinates. The coordinates are derived from the following: left, top, width, height, scaleX, scaleY, skewX, skewY, angle, strokeWidth. The coordinates do not depend on viewport changes. The coordinates get updated with setCoords. You can calculate them without updating with ()

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).aCoords

Defined in

src/shapes/Object/ObjectGeometry.ts:63

---

absolutePositioned

absolutePositioned: boolean

Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will not be influenced by the object transform. This will make the clipPath relative to the canvas, but clipping just a particular object. WARNING this is beta, this feature may change or be renamed. since 2.4.0

Default

false

Implementation of

GroupProps.absolutePositioned

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).absolutePositioned

Defined in

src/shapes/Object/Object.ts:218

---

angle

angle: TDegree

Angle of rotation of an object (in degrees)

Default

0

Implementation of

GroupProps.angle

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).angle

Defined in

src/shapes/Object/ObjectGeometry.ts:581

---

backgroundColor

backgroundColor: string

Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/

Default

Implementation of

GroupProps.backgroundColor

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).backgroundColor

Defined in

src/shapes/Object/Object.ts:205

---

borderColor

borderColor: string

Color of controlling borders of an object (when it’s active)

Default

rgb(178,204,255)

Implementation of

GroupProps.borderColor

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).borderColor

Defined in

src/shapes/Object/InteractiveObject.ts:74

---

borderDashArray

borderDashArray: null | number[]

Array specifying dash pattern of an object’s borders (hasBorder must be true)

Since

1.6.2

Implementation of

GroupProps.borderDashArray

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).borderDashArray

Defined in

src/shapes/Object/InteractiveObject.ts:75

---

borderOpacityWhenMoving

borderOpacityWhenMoving: number

Opacity of object’s controlling borders when object is active and moving

Default

0.4

Implementation of

GroupProps.borderOpacityWhenMoving

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).borderOpacityWhenMoving

Defined in

src/shapes/Object/InteractiveObject.ts:76

---

borderScaleFactor

borderScaleFactor: number

Scale factor of object’s controlling borders bigger number will make a thicker border border is 1, so this is basically a border thickness since there is no way to change the border itself.

Default

1

Implementation of

GroupProps.borderScaleFactor

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).borderScaleFactor

Defined in

src/shapes/Object/InteractiveObject.ts:77

---

centeredRotation

centeredRotation: boolean

When true the object will rotate on its center. When false will rotate around the origin point defined by originX and originY. The value of this property is IGNORED during a transform if the canvas has already centeredRotation set to true The object method rotate will always consider this property and never the canvas’s one.

Since

1.3.4

Default

Implementation of

GroupProps.centeredRotation

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).centeredRotation

Defined in

src/shapes/Object/Object.ts:219

---

centeredScaling

centeredScaling: boolean

When true, this object will use center point as the origin of transformation when being scaled via the controls.

Since

1.3.4

Default

Implementation of

GroupProps.centeredScaling

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).centeredScaling

Defined in

src/shapes/Object/Object.ts:220

---

clipPath?

optional clipPath: BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>

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 of the object cacheCanvas. If you want 0,0 of a clipPath to align with an object center, use clipPath.originX/Y to ‘center’

Implementation of

GroupProps.clipPath

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).clipPath

Defined in

src/shapes/Object/Object.ts:216

---

clipPathId?

optional clipPathId: string

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.

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).clipPathId

Defined in

src/shapes/Object/FabricObjectSVGExportMixin.ts:14

---

controls

controls: TControlSet

holds the controls for the object. controls are added by default_controls.js

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).controls

Defined in

src/shapes/Object/InteractiveObject.ts:118

---

cornerColor

cornerColor: string

Color of controlling corners of an object (when it’s active)

Default

rgb(178,204,255)

Implementation of

GroupProps.cornerColor

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).cornerColor

Defined in

src/shapes/Object/InteractiveObject.ts:68

---

cornerDashArray

cornerDashArray: null | number[]

Array specifying dash pattern of an object’s control (hasBorder must be true)

Since

1.6.2

Default

null

Implementation of

GroupProps.cornerDashArray

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).cornerDashArray

Defined in

src/shapes/Object/InteractiveObject.ts:71

---

cornerSize

cornerSize: number

Size of object’s controlling corners (in pixels)

Default

13

Implementation of

GroupProps.cornerSize

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).cornerSize

Defined in

src/shapes/Object/InteractiveObject.ts:65

---

cornerStrokeColor

cornerStrokeColor: string

Color of controlling corners of an object (when it’s active and transparentCorners false)

Since

1.6.2

Default

''

Implementation of

GroupProps.cornerStrokeColor

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).cornerStrokeColor

Defined in

src/shapes/Object/InteractiveObject.ts:69

---

cornerStyle

cornerStyle: "circle" | "rect"

Specify style of control, ‘rect’ or ‘circle’ This is deprecated. In the future there will be a standard control render And you can swap it with one of the alternative proposed with the control api

Since

1.6.2

Default

'rect'

Deprecated

This API is no longer supported and may be removed in a future release.

Implementation of

GroupProps.cornerStyle

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).cornerStyle

Defined in

src/shapes/Object/InteractiveObject.ts:70

---

dirty

dirty: boolean

When set to true, object’s cache will be rerendered next render call. since 1.7.0

Default

true

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).dirty

Defined in

src/shapes/Object/Object.ts:245

---

evented

evented: boolean

When set to false, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4

Default

Implementation of

GroupProps.evented

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).evented

Defined in

src/shapes/Object/InteractiveObject.ts:82

---

excludeFromExport

excludeFromExport: boolean

When true, object is not exported in OBJECT/JSON

Since

1.6.3

Default

Implementation of

GroupProps.excludeFromExport

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).excludeFromExport

Defined in

src/shapes/Object/Object.ts:212

---

fill

fill: null | string | TFiller

Color of object’s fill takes css colors https://www.w3.org/TR/css-color-3/

Default

rgb(0,0,0)

Implementation of

GroupProps.fill

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).fill

Defined in

src/shapes/Object/Object.ts:195

---

fillRule

fillRule: CanvasFillRule

Fill rule used to fill an object accepted values are nonzero, evenodd Backwards incompatibility note: This property was used for setting globalCompositeOperation until v1.4.12 (use globalCompositeOperation instead)

Default

nonzero

Implementation of

GroupProps.fillRule

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).fillRule

Defined in

src/shapes/Object/Object.ts:196

---

flipX

flipX: boolean

When true, an object is rendered as flipped horizontally

Default

false

Implementation of

GroupProps.flipX

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).flipX

Defined in

src/shapes/Object/ObjectGeometry.ts:567

---

flipY

flipY: boolean

When true, an object is rendered as flipped vertically

Default

false

Implementation of

GroupProps.flipY

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).flipY

Defined in

src/shapes/Object/ObjectGeometry.ts:568

---

globalCompositeOperation

globalCompositeOperation: GlobalCompositeOperation

Composite rule used for canvas globalCompositeOperation

Default

Implementation of

GroupProps.globalCompositeOperation

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).globalCompositeOperation

Defined in

src/shapes/Object/Object.ts:204

---

hasBorders

hasBorders: boolean

When set to false, object’s controlling borders are not rendered

Default

Implementation of

GroupProps.hasBorders

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).hasBorders

Defined in

src/shapes/Object/InteractiveObject.ts:78

---

hasControls

hasControls: boolean

When set to false, object’s controls are not displayed and can not be used to manipulate object

Default

true

Implementation of

GroupProps.hasControls

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).hasControls

Defined in

src/shapes/Object/InteractiveObject.ts:72

---

height

height: number

Object height

Default

Implementation of

GroupProps.height

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).height

Defined in

src/shapes/Object/ObjectGeometry.ts:566

---

hoverCursor

hoverCursor: null | string

Default cursor value used when hovering over this object on canvas

Default

null

Implementation of

GroupProps.hoverCursor

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).hoverCursor

Defined in

src/shapes/Object/InteractiveObject.ts:86

---

includeDefaultValues

includeDefaultValues: boolean

When false, default object’s values are not included in its serialization

Default

Implementation of

GroupProps.includeDefaultValues

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).includeDefaultValues

Defined in

src/shapes/Object/Object.ts:211

---

interactive

interactive: boolean

Used to allow targeting of object inside groups. set to true if you want to select an object inside a group.
REQUIRES subTargetCheck set to true This will be not removed but slowly replaced with a method setInteractive that will take care of enabling subTargetCheck and necessary object events. There is too much attached to group interactivity to just be evaluated by a boolean in the code

Default

Deprecated

This API is no longer supported and may be removed in a future release.

Implementation of

GroupProps.interactive

Defined in

src/shapes/Group.ts:108

---

inverted

inverted: boolean

Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath since 2.4.0

Default

false

Implementation of

GroupProps.inverted

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).inverted

Defined in

src/shapes/Object/Object.ts:217

---

isMoving?

optional isMoving: boolean

internal boolean to signal the code that the object is part of the move action.

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isMoving

Defined in

src/shapes/Object/InteractiveObject.ts:124

---

layoutManager

layoutManager: LayoutManager

Implementation of

GroupProps.layoutManager

Defined in

src/shapes/Group.ts:110

---

left

left: number

Left position of an object. Note that by default it’s relative to object left. You can change this by setting originX

Default

0

Implementation of

GroupProps.left

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).left

Defined in

src/shapes/Object/ObjectGeometry.ts:564

---

lockMovementX

lockMovementX: boolean

When true, object horizontal movement is locked

Default

Implementation of

GroupProps.lockMovementX

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).lockMovementX

Defined in

src/shapes/Object/InteractiveObject.ts:56

---

lockMovementY

lockMovementY: boolean

When true, object vertical movement is locked

Default

Implementation of

GroupProps.lockMovementY

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).lockMovementY

Defined in

src/shapes/Object/InteractiveObject.ts:57

---

lockRotation

lockRotation: boolean

When true, object rotation is locked

Default

Implementation of

GroupProps.lockRotation

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).lockRotation

Defined in

src/shapes/Object/InteractiveObject.ts:58

---

lockScalingFlip

lockScalingFlip: boolean

When true, object cannot be flipped by scaling into negative values

Default

Implementation of

GroupProps.lockScalingFlip

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).lockScalingFlip

Defined in

src/shapes/Object/InteractiveObject.ts:63

---

lockScalingX

lockScalingX: boolean

When true, object horizontal scaling is locked

Default

Implementation of

GroupProps.lockScalingX

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).lockScalingX

Defined in

src/shapes/Object/InteractiveObject.ts:59

---

lockScalingY

lockScalingY: boolean

When true, object vertical scaling is locked

Default

Implementation of

GroupProps.lockScalingY

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).lockScalingY

Defined in

src/shapes/Object/InteractiveObject.ts:60

---

lockSkewingX

lockSkewingX: boolean

When true, object horizontal skewing is locked

Default

Implementation of

GroupProps.lockSkewingX

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).lockSkewingX

Defined in

src/shapes/Object/InteractiveObject.ts:61

---

lockSkewingY

lockSkewingY: boolean

When true, object vertical skewing is locked

Default

Implementation of

GroupProps.lockSkewingY

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).lockSkewingY

Defined in

src/shapes/Object/InteractiveObject.ts:62

---

matrixCache?

optional matrixCache: TMatrixCache

storage cache for object full transform matrix

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).matrixCache

Defined in

src/shapes/Object/ObjectGeometry.ts:73

---

minScaleLimit

minScaleLimit: number

Minimum allowed scale value of an object

Default

0

Implementation of

GroupProps.minScaleLimit

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).minScaleLimit

Defined in

src/shapes/Object/Object.ts:190

---

moveCursor

moveCursor: null | string

Default cursor value used when moving this object on canvas

Default

null

Implementation of

GroupProps.moveCursor

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).moveCursor

Defined in

src/shapes/Object/InteractiveObject.ts:87

---

noScaleCache

noScaleCache: boolean

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. default to true since 1.7.0

Default

true

Implementation of

GroupProps.noScaleCache

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).noScaleCache

Defined in

src/shapes/Object/InteractiveObject.ts:51

---

oCoords

oCoords: Record<string, TOCoord>

The object’s controls’ position in viewport coordinates Calculated by Control#positionHandler and Control#calcCornerCoords, depending on padding. corner/touchCorner describe the 4 points forming the interactive area of the corner. Used to draw and locate controls.

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).oCoords

Defined in

src/shapes/Object/InteractiveObject.ts:95

---

objectCaching

objectCaching: boolean

When true, object is cached on an additional canvas. When false, object is not cached unless necessary ( clipPath ) default to true

Since

1.7.0

Default

true

Implementation of

GroupProps.objectCaching

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).objectCaching

Defined in

src/shapes/Object/Object.ts:214

---

opacity

opacity: number

Opacity of an object

Default

1

Implementation of

GroupProps.opacity

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).opacity

Defined in

src/shapes/Object/Object.ts:192

---

originX

originX: TOriginX

Deprecated

please use ‘center’ as value in new projects

Implementation of

GroupProps.originX

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).originX

Defined in

src/shapes/Object/ObjectGeometry.ts:576

---

originY

originY: TOriginY

Deprecated

please use ‘center’ as value in new projects

Implementation of

GroupProps.originY

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).originY

Defined in

src/shapes/Object/ObjectGeometry.ts:580

---

ownMatrixCache?

optional ownMatrixCache: TMatrixCache

storage cache for object transform matrix

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).ownMatrixCache

Defined in

src/shapes/Object/ObjectGeometry.ts:68

---

padding

padding: number

Padding between object and its controlling borders (in pixels)

Default

0

Implementation of

GroupProps.padding

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).padding

Defined in

src/shapes/Object/ObjectGeometry.ts:53

---

paintFirst

paintFirst: "fill" | "stroke"

Determines if the fill or the stroke is drawn first (one of “fill” or “stroke”)

Default

Implementation of

GroupProps.paintFirst

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).paintFirst

Defined in

src/shapes/Object/Object.ts:194

---

parent?

optional parent: Group

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

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).parent

Defined in

src/shapes/Object/Object.ts:1636

---

perPixelTargetFind

perPixelTargetFind: boolean

When set to true, objects are “found” on canvas on per-pixel basis rather than according to bounding box

Default

Implementation of

GroupProps.perPixelTargetFind

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).perPixelTargetFind

Defined in

src/shapes/Object/InteractiveObject.ts:83

---

scaleX

scaleX: number

Object scale factor (horizontal)

Default

1

Implementation of

GroupProps.scaleX

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).scaleX

Defined in

src/shapes/Object/ObjectGeometry.ts:569

---

scaleY

scaleY: number

Object scale factor (vertical)

Default

1

Implementation of

GroupProps.scaleY

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).scaleY

Defined in

src/shapes/Object/ObjectGeometry.ts:570

---

selectable

selectable: boolean

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.

Default

Implementation of

GroupProps.selectable

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).selectable

Defined in

src/shapes/Object/InteractiveObject.ts:81

---

selectionBackgroundColor

selectionBackgroundColor: string

Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods.

Default

Deprecated

This API is no longer supported and may be removed in a future release.

Implementation of

GroupProps.selectionBackgroundColor

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).selectionBackgroundColor

Defined in

src/shapes/Object/InteractiveObject.ts:79

---

shadow

shadow: null | Shadow

Shadow object representing shadow of this shape

Default

null

Implementation of

GroupProps.shadow

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).shadow

Defined in

src/shapes/Object/Object.ts:207

---

skewX

skewX: number

Angle of skew on x axes of an object (in degrees)

Default

0

Implementation of

GroupProps.skewX

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).skewX

Defined in

src/shapes/Object/ObjectGeometry.ts:571

---

skewY

skewY: number

Angle of skew on y axes of an object (in degrees)

Default

0

Implementation of

GroupProps.skewY

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).skewY

Defined in

src/shapes/Object/ObjectGeometry.ts:572

---

snapAngle?

optional snapAngle: TDegree

The angle that an object will lock to while rotating.

Implementation of

GroupProps.snapAngle

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).snapAngle

Defined in

src/shapes/Object/InteractiveObject.ts:53

---

snapThreshold?

optional snapThreshold: TDegree

The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle.

Implementation of

GroupProps.snapThreshold

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).snapThreshold

Defined in

src/shapes/Object/InteractiveObject.ts:54

---

stroke

stroke: null | string | TFiller

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/

Default

null

Implementation of

GroupProps.stroke

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).stroke

Defined in

src/shapes/Object/Object.ts:197

---

strokeDashArray

strokeDashArray: null | number[]

Array specifying dash pattern of an object’s stroke (stroke must be defined)

Default

null;

Implementation of

GroupProps.strokeDashArray

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).strokeDashArray

Defined in

src/shapes/Object/Object.ts:198

---

strokeDashOffset

strokeDashOffset: number

Line offset of an object’s stroke

Default

0

Implementation of

GroupProps.strokeDashOffset

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).strokeDashOffset

Defined in

src/shapes/Object/Object.ts:199

---

strokeLineCap

strokeLineCap: CanvasLineCap

Line endings style of an object’s stroke (one of “butt”, “round”, “square”)

Default

butt

Implementation of

GroupProps.strokeLineCap

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).strokeLineCap

Defined in

src/shapes/Object/Object.ts:200

---

strokeLineJoin

strokeLineJoin: CanvasLineJoin

Corner style of an object’s stroke (one of “bevel”, “round”, “miter”)

Default

Implementation of

GroupProps.strokeLineJoin

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).strokeLineJoin

Defined in

src/shapes/Object/Object.ts:201

---

strokeMiterLimit

strokeMiterLimit: number

Maximum miter length (used for strokeLineJoin = “miter”) of an object’s stroke

Default

4

Implementation of

GroupProps.strokeMiterLimit

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).strokeMiterLimit

Defined in

src/shapes/Object/Object.ts:202

---

strokeUniform

strokeUniform: boolean

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. this Property does not work on Text classes or drawing call that uses strokeText,fillText methods default to false

Since

2.6.0

Default

false

Default

false

Implementation of

GroupProps.strokeUniform

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).strokeUniform

Defined in

src/shapes/Object/ObjectGeometry.ts:583

---

strokeWidth

strokeWidth: number

Width of a stroke used to render this object

Default

1

Implementation of

GroupProps.strokeWidth

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).strokeWidth

Defined in

src/shapes/Object/ObjectGeometry.ts:582

---

subTargetCheck

subTargetCheck: boolean

Used to optimize performance set to false if you don’t need contained objects to be targets of events

Default

Implementation of

GroupProps.subTargetCheck

Defined in

src/shapes/Group.ts:94

---

top

top: number

Top position of an object. Note that by default it’s relative to object top. You can change this by setting originY

Default

0

Implementation of

GroupProps.top

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).top

Defined in

src/shapes/Object/ObjectGeometry.ts:563

---

touchCornerSize

touchCornerSize: number

Size of object’s controlling corners when touch interaction is detected

Default

24

Implementation of

GroupProps.touchCornerSize

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).touchCornerSize

Defined in

src/shapes/Object/InteractiveObject.ts:66

---

transparentCorners

transparentCorners: boolean

When true, object’s controlling corners are rendered as transparent inside (i.e. stroke instead of fill)

Default

true

Implementation of

GroupProps.transparentCorners

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).transparentCorners

Defined in

src/shapes/Object/InteractiveObject.ts:67

---

visible

visible: boolean

When set to false, an object is not rendered on canvas

Default

Implementation of

GroupProps.visible

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).visible

Defined in

src/shapes/Object/Object.ts:209

---

width

width: number

Object width

Default

Implementation of

GroupProps.width

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).width

Defined in

src/shapes/Object/ObjectGeometry.ts:565

---

cacheProperties

static cacheProperties: string[]

List of properties to consider when checking if cache needs refresh Those properties are checked by calls to Object.set(key, value). If the key is in this list, the object is marked as dirty and refreshed at the next render

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).cacheProperties

Defined in

src/shapes/Object/Object.ts:237

---

colorProperties

static colorProperties: string[]

List of properties to consider for animating colors.

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).colorProperties

Defined in

src/shapes/Object/Object.ts:1543

---

customProperties

static customProperties: string[] = []

Define a list of custom properties that will be serialized when instance.toObject() gets called

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).customProperties

Defined in

src/shapes/Object/Object.ts:1784

---

ownDefaults

static ownDefaults: Record<string, any> = groupDefaultValues

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).ownDefaults

Defined in

src/shapes/Group.ts:122

---

stateProperties

static stateProperties: string[]

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 needs its cache regenerated during a .set call

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).stateProperties

Defined in

src/shapes/Object/Object.ts:228

---

type

static type: string = 'Group'

Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. The setter exists to avoid type errors in old code and possibly current deserialization code. DO NOT build new code around this type value

TODO

add sustainable warning message

Deprecated

This API is no longer supported and may be removed in a future release.

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).type

Defined in

src/shapes/Group.ts:120

Accessors

type

get type(): string

Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. The setter exists to avoid type errors in old code and possibly current deserialization code. DO NOT build new code around this type value

TODO

add sustainable warning message

Deprecated

This API is no longer supported and may be removed in a future release.

set type(value): void

Parameters

• value: string

Returns

string

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).type

Defined in

src/shapes/Object/Object.ts:357

Methods

_drawClipPath()

_drawClipPath(ctx, clipPath, context): void

Prepare clipPath state and cache and draw it on instance’s cache

Parameters

• ctx: CanvasRenderingContext2D

• clipPath: undefined | BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>

• context: DrawContext

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._drawClipPath

Defined in

src/shapes/Object/Object.ts:920

---

_limitCacheSize()

_limitCacheSize(dims): any

Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit those numbers are configurable so that you can get as much detail as you want making bargain with performances.

Parameters

• dims: any

Returns

any

.width width of canvas

.height height of canvas

.zoomX zoomX zoom value to unscale the canvas before drawing cache

.zoomY zoomY zoom value to unscale the canvas before drawing cache

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._limitCacheSize

Defined in

src/shapes/Object/Object.ts:406

---

_onObjectAdded()

_onObjectAdded(object): void

Parameters

• object: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Returns

void

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._onObjectAdded

Defined in

src/shapes/Group.ts:258

---

_onStackOrderChanged()

_onStackOrderChanged(): void

Returns

void

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._onStackOrderChanged

Defined in

src/shapes/Group.ts:288

---

_removeCacheCanvas()

_removeCacheCanvas(): void

Remove cacheCanvas and its dimensions from the objects

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._removeCacheCanvas

Defined in

src/shapes/Object/Object.ts:756

---

_renderControls()

_renderControls(ctx, styleOverride?): void

Renders controls and borders for the object the context here is not transformed

Parameters

• ctx: CanvasRenderingContext2D

Context to render on

• styleOverride?: TStyleOverride = {}

properties to override the object style

Returns

void

Todo

move to interactivity

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._renderControls

Defined in

src/shapes/Object/InteractiveObject.ts:435

---

_setClippingProperties()

_setClippingProperties(ctx): void

Parameters

• ctx: CanvasRenderingContext2D

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._setClippingProperties

Defined in

src/shapes/Object/Object.ts:1062

---

_setFillStyles()

_setFillStyles(ctx, __namedParameters): void

Parameters

• ctx: CanvasRenderingContext2D

• __namedParameters: Pick<Group, "fill">

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._setFillStyles

Defined in

src/shapes/Object/Object.ts:1051

---

_setStrokeStyles()

_setStrokeStyles(ctx, decl): void

Parameters

• ctx: CanvasRenderingContext2D

• decl: Pick<Group, "stroke" | "strokeDashOffset" | "strokeLineCap" | "strokeLineJoin" | "strokeMiterLimit" | "strokeWidth">

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._setStrokeStyles

Defined in

src/shapes/Object/Object.ts:1009

---

_setupCompositeOperation()

_setupCompositeOperation(ctx): void

Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property

Parameters

• ctx: CanvasRenderingContext2D

Rendering canvas context

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._setupCompositeOperation

Defined in

src/shapes/Object/Object.ts:1518

---

_toSVG()

_toSVG(reviver?): string[]

Returns svg representation of an instance

Parameters

• reviver?: TSVGReviver

Method for further parsing of svg representation.

Returns

string[]

svg representation of an instance

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._toSVG

Defined in

src/shapes/Group.ts:637

---

add()

add(…objects): number

Add objects

Parameters

• …objects: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Returns

number

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).add

Defined in

src/shapes/Group.ts:228

---

addPaintOrder()

addPaintOrder(this): string

Parameters

• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Returns

string

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).addPaintOrder

Defined in

src/shapes/Object/FabricObjectSVGExportMixin.ts:249

---

animate()

animate<T>(animatable, options?): Record<string, TAnimation<T>>

Animates object’s properties

Type Parameters

• T extends number | number[] | TColorArg

Parameters

• animatable: Record<string, T>

map of keys and end values

• options?: Partial<AnimationOptions<T>>

Returns

Record<string, TAnimation<T>>

map of animation contexts

As object — multiple properties

object.animate({ left: …, top: … }); object.animate({ left: …, top: … }, { duration: … });

Tutorial

http://fabricjs.com/fabric-intro-part-2#animation

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).animate

Defined in

src/shapes/Object/Object.ts:1557

---

bringObjectForward()

bringObjectForward(object, intersecting?): boolean

Moves an object or a selection up in stack of drawn objects An optional parameter, intersecting allows to move the object in front of the first intersecting object. Where intersection is calculated with bounding box. If no intersection is found, there will not be change in the stack.

Parameters

• object: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Object to send

• intersecting?: boolean

If true, send object in front of next upper intersecting object

Returns

boolean

true if change occurred

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).bringObjectForward

Defined in

src/Collection.ts:240

---

bringObjectToFront()

bringObjectToFront(object): boolean

Moves an object or the objects of a multiple selection to the top of the stack of drawn objects

Parameters

• object: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Object to send

Returns

boolean

true if change occurred

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).bringObjectToFront

Defined in

src/Collection.ts:194

---

calcACoords()

calcACoords(): TCornerPoint

Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes.

Returns

TCornerPoint

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).calcACoords

Defined in

src/shapes/Object/ObjectGeometry.ts:427

---

calcOCoords()

calcOCoords(): Record<string, TOCoord>

Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler WARNING: changing what is passed to positionHandler is a breaking change, since position handler is a public api and should be done just if extremely necessary

Returns

Record<string, TOCoord>

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).calcOCoords

Defined in

src/shapes/Object/InteractiveObject.ts:255

---

calcOwnMatrix()

calcOwnMatrix(): TMat2D

calculate transform matrix that represents the current transformations from the object’s properties, this matrix does not include the group transformation

Returns

TMat2D

transform matrix for the object

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).calcOwnMatrix

Defined in

src/shapes/Object/ObjectGeometry.ts:513

---

calcTransformMatrix()

calcTransformMatrix(skipGroup?): TMat2D

calculate transform matrix that represents the current transformations from the object’s properties.

Parameters

• skipGroup?: boolean = false

return transform matrix for object not counting parent transformations There are some situation in which this is useful to avoid the fake rotation.

Returns

TMat2D

transform matrix for the object

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).calcTransformMatrix

Defined in

src/shapes/Object/ObjectGeometry.ts:485

---

canDrop()

canDrop(_e): boolean

Override to customize drag and drop behavior

Parameters

• _e: DragEvent

Returns

boolean

true if the object currently dragged can be dropped on the target

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).canDrop

Defined in

src/shapes/Object/InteractiveObject.ts:701

---

clearContextTop()

clearContextTop(restoreManually?): undefined | CanvasRenderingContext2D

Clears the canvas.contextTop in a specific area that corresponds to the object’s bounding box that is in the canvas.contextContainer. This function is used to clear pieces of contextTop where we render ephemeral effects on top of the object. Example: blinking cursor text selection, drag effects.

Parameters

• restoreManually?: boolean

When true won’t restore the context after clear, in order to draw something else.

Returns

undefined | CanvasRenderingContext2D

canvas.contextTop that is either still transformed with the object transformMatrix, or restored to neutral transform

Todo

discuss swapping restoreManually with a renderCallback, but think of async issues

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).clearContextTop

Defined in

src/shapes/Object/InteractiveObject.ts:627

---

clone()

clone(propertiesToInclude?): Promise<Group>

Clones an instance.

Parameters

• propertiesToInclude?: string[]

Any properties that you might want to additionally include in the output

Returns

Promise<Group>

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).clone

Defined in

src/shapes/Object/Object.ts:1292

---

cloneAsImage()

cloneAsImage(options?): FabricImage<Partial<ImageProps>, SerializedImageProps, ObjectEvents>

Creates an instance of Image out of an object makes use of toCanvasElement. Once this method was based on toDataUrl and loadImage, so it also had a quality and format option. toCanvasElement is faster and produce no loss of quality. If you need to get a real Jpeg or Png from an object, using toDataURL is the right way to do it. toCanvasElement and then toBlob from the obtained canvas is also a good option.

Parameters

• options?: ObjectToCanvasElementOptions

for clone as image, passed to toDataURL

Returns

FabricImage<Partial<ImageProps>, SerializedImageProps, ObjectEvents>

Object cloned as image.

Todo

fix the export type, it could not be Image but the type that getClass return for ‘image’.

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).cloneAsImage

Defined in

src/shapes/Object/Object.ts:1318

---

collectObjects()

collectObjects(bbox, options): InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

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. This is meant to work with selection. Is not a generic method.

Parameters

• bbox: TBBox

a bounding box in scene coordinates

• options = {}

an object with includeIntersecting

• options.includeIntersecting?: boolean = true

Returns

InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

array of objects contained in the bounding box, ordered from top to bottom stacking wise

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).collectObjects

Defined in

src/Collection.ts:326

---

complexity()

complexity(): number

Returns

number

complexity

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).complexity

Defined in

src/Collection.ts:165

---

contains()

contains(object, deep?): boolean

Returns true if collection contains an object.
Prefer using FabricObject#isDescendantOf for performance reasons instead of a.contains(b) use b.isDescendantOf(a)

Parameters

• object: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Object to check against

• deep?: boolean

true to check all descendants, false to check only _objects

Returns

boolean

true if collection contains an object

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).contains

Defined in

src/Collection.ts:148

---

containsPoint()

containsPoint(point): boolean

Checks if point is inside the object

Parameters

• point: Point

Point to check against

Returns

boolean

true if point is inside the object

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).containsPoint

Defined in

src/shapes/Object/ObjectGeometry.ts:282

---

dispose()

dispose(): void

cancel instance’s running animations override if necessary to dispose artifacts such as clipPath

Returns

void

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).dispose

Defined in

src/shapes/Group.ts:605

---

drawBorders()

drawBorders(ctx, options, styleOverride?): void

Draws borders of an object’s bounding box. Requires public properties: width, height Requires public options: padding, borderColor

Parameters

• ctx: CanvasRenderingContext2D

Context to draw on

• options: Required<Omit<TComposeMatrixArgs, "flipX" | "flipY">>

object representing current object parameters

• styleOverride?: TStyleOverride

object to override the object style

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).drawBorders

Defined in

src/shapes/Object/InteractiveObject.ts:478

---

drawCacheOnCanvas()

drawCacheOnCanvas(this, ctx): void

Paint the cached copy of the object on the target context.

Parameters

• this: TCachedFabricObject<BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>>

• ctx: CanvasRenderingContext2D

Context to render on

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).drawCacheOnCanvas

Defined in

src/shapes/Object/Object.ts:942

---

drawClipPathOnCache()

drawClipPathOnCache(ctx, clipPath, canvasWithClipPath): void

Execute the drawing operation for an object clipPath

Parameters

• ctx: CanvasRenderingContext2D

Context to render on

• clipPath: BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>

• canvasWithClipPath: HTMLCanvasElement

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).drawClipPathOnCache

Defined in

src/shapes/Object/Object.ts:847

---

drawControls()

drawControls(ctx, styleOverride): void

Draws corners of an object’s bounding box. Requires public properties: width, height Requires public options: cornerSize, padding Be aware that since fabric 6.0 this function does not call setCoords anymore. setCoords needs to be called manually if the object of which we are rendering controls is outside the standard selection and transform process.

Parameters

• ctx: CanvasRenderingContext2D

Context to draw on

• styleOverride: Partial<Pick<InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>, "cornerStyle" | "cornerSize" | "cornerColor" | "cornerStrokeColor" | "cornerDashArray" | "transparentCorners">> = {}

object to override the object style

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).drawControls

Defined in

src/shapes/Object/InteractiveObject.ts:550

---

drawControlsConnectingLines()

drawControlsConnectingLines(ctx, size): void

Draws lines from a borders of an object’s bounding box to controls that have withConnection property set. Requires public properties: width, height Requires public options: padding, borderColor

Parameters

• ctx: CanvasRenderingContext2D

Context to draw on

• size: Point

object size x = width, y = height

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).drawControlsConnectingLines

Defined in

src/shapes/Object/InteractiveObject.ts:517

---

drawObject()

drawObject(ctx, forClipping, context): void

Execute the drawing operation for an object on a specified context

Parameters

• ctx: CanvasRenderingContext2D

Context to render on

• forClipping: undefined | boolean

• context: DrawContext

Returns

void

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).drawObject

Defined in

src/shapes/Group.ts:496

---

drawSelectionBackground()

drawSelectionBackground(ctx): void

Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor this function is called when the context is transformed has checks to be skipped when the object is on a staticCanvas

Parameters

• ctx: CanvasRenderingContext2D

Context to draw on

Returns

void

Todo

evaluate if make this disappear in favor of a pre-render hook for objects this was added by Andrea Bogazzi to make possible some feature for work reasons it seemed a good option, now is an edge case

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).drawSelectionBackground

Defined in

src/shapes/Object/InteractiveObject.ts:375

---

findCommonAncestors()

findCommonAncestors<T>(other): AncestryComparison

Compare ancestors

Type Parameters

• T extends Group

Parameters

• other: T

Returns

AncestryComparison

an object that represent the ancestry situation.

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).findCommonAncestors

Defined in

src/shapes/Object/Object.ts:1675

---

findNewLowerIndex()

findNewLowerIndex(object, idx, intersecting?): number

Parameters

• object: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

• idx: number

• intersecting?: boolean

Returns

number

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).findNewLowerIndex

Defined in

src/Collection.ts:272

---

findNewUpperIndex()

findNewUpperIndex(object, idx, intersecting?): number

Parameters

• object: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

• idx: number

• intersecting?: boolean

Returns

number

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).findNewUpperIndex

Defined in

src/Collection.ts:295

---

fire()

fire<K>(eventName, options?): void

Fires event with an optional options object

Type Parameters

• K extends keyof GroupEvents

Parameters

• eventName: K

Event name to fire

• options?: GroupEvents[K]

Options object

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).fire

Defined in

src/Observable.ts:167

---

forEachControl()

forEachControl(fn): void

Calls a function for each control. The function gets called, with the control, the control’s key and the object that is calling the iterator

Parameters

• fn

function to iterate over the controls over

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).forEachControl

Defined in

src/shapes/Object/InteractiveObject.ts:353

---

forEachObject()

forEachObject(callback): void

Executes given function for each object in this group A simple shortcut for getObjects().forEach, before es6 was more complicated, now is just a shortcut.

Parameters

• callback

Callback invoked with current object as first argument, index - as second and an array of all objects - as third.

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).forEachObject

Defined in

src/Collection.ts:91

---

get()

get(property): any

Basic getter

Parameters

• property: string

Property name

Returns

any

value of a property

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).get

Defined in

src/CommonMethods.ts:59

---

getActiveControl()

getActiveControl(): undefined | object

Returns

undefined | object

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getActiveControl

Defined in

src/shapes/Object/InteractiveObject.ts:194

---

getAncestors()

getAncestors(): Ancestors

Returns

Ancestors

ancestors (excluding ActiveSelection) from bottom to top

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getAncestors

Defined in

src/shapes/Object/Object.ts:1658

---

getBoundingRect()

getBoundingRect(): TBBox

Returns coordinates of object’s bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas.

Returns

TBBox

Object with left, top, width, height properties

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getBoundingRect

Defined in

src/shapes/Object/ObjectGeometry.ts:343

---

getCanvasRetinaScaling()

getCanvasRetinaScaling(): number

Returns

number

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getCanvasRetinaScaling

Defined in

src/shapes/Object/ObjectGeometry.ts:400

---

getCenterPoint()

getCenterPoint(): Point

Returns the center coordinates of the object relative to canvas

Returns

Point

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getCenterPoint

Defined in

src/shapes/Object/ObjectGeometry.ts:732

---

getCoords()

getCoords(): Point[]

Returns

Point[]

[tl, tr, br, bl] in the scene plane

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getCoords

Defined in

src/shapes/Object/ObjectGeometry.ts:204

---

getObjectOpacity()

getObjectOpacity(): number

Return the object opacity counting also the group property

Returns

number

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getObjectOpacity

Defined in

src/shapes/Object/Object.ts:607

---

getObjectScaling()

getObjectScaling(): Point

Return the object scale factor counting also the group scaling

Returns

Point

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getObjectScaling

Defined in

src/shapes/Object/Object.ts:576

---

getObjects()

getObjects(…types?): FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Returns an array of children objects of this instance

Parameters

• …types?: string[]

When specified, only objects of these types are returned

Returns

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getObjects

Defined in

src/Collection.ts:108

---

getPointByOrigin()

getPointByOrigin(originX, originY): Point

Returns the position of the object as if it has a different origin. Take an object that has left, top set to 100, 100 with origin ‘left’, ‘top’. Return the values of left top ( wrapped in a point ) that you would need to keep the same position if origin where different. Alternatively you can use this to also find which point in the parent plane is a specific origin ( where is the bottom right corner of my object? )

Parameters

• originX: TOriginX

Horizontal origin: ‘left’, ‘center’ or ‘right’

• originY: TOriginY

Vertical origin: ‘top’, ‘center’ or ‘bottom’

Returns

Point

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getPointByOrigin

Defined in

src/shapes/Object/ObjectGeometry.ts:762

---

getRelativeCenterPoint()

getRelativeCenterPoint(): Point

Returns the center coordinates of the object relative to it’s parent

Returns

Point

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getRelativeCenterPoint

Defined in

src/shapes/Object/ObjectGeometry.ts:743

---

getRelativeX()

getRelativeX(): number

Returns

number

x position according to object’s originX property in parent’s coordinate plane
if parent is canvas then this property is identical to getX

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getRelativeX

Defined in

src/shapes/Object/ObjectGeometry.ts:115

---

getRelativeXY()

getRelativeXY(): Point

Returns

Point

x,y position according to object’s originX originY properties in parent’s coordinate plane

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getRelativeXY

Defined in

src/shapes/Object/ObjectGeometry.ts:176

---

getRelativeY()

getRelativeY(): number

Returns

number

y position according to object’s originY property in parent’s coordinate plane
if parent is canvas then this property is identical to getY

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getRelativeY

Defined in

src/shapes/Object/ObjectGeometry.ts:131

---

getScaledHeight()

getScaledHeight(): number

Returns height of an object bounding box counting transformations

Returns

number

height value

Todo

shouldn’t this account for group transform and return the actual size in canvas coordinate plane?

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getScaledHeight

Defined in

src/shapes/Object/ObjectGeometry.ts:361

---

getScaledWidth()

getScaledWidth(): number

Returns width of an object’s bounding box counting transformations

Returns

number

width value

Todo

shouldn’t this account for group transform and return the actual size in canvas coordinate plane?

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getScaledWidth

Defined in

src/shapes/Object/ObjectGeometry.ts:352

---

getSvgCommons()

getSvgCommons(this): string

Returns id attribute for svg output

Parameters

• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents> & object

Returns

string

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getSvgCommons

Defined in

src/shapes/Object/FabricObjectSVGExportMixin.ts:84

---

getSvgFilter()

getSvgFilter(this): string

Returns filter for svg shadow

Parameters

• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Returns

string

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getSvgFilter

Defined in

src/shapes/Object/FabricObjectSVGExportMixin.ts:76

---

getSvgStyles()

getSvgStyles(): string

Returns styles-string for svg-export, specific version for group

Returns

string

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getSvgStyles

Defined in

src/shapes/Group.ts:652

---

getSvgTransform()

getSvgTransform(this, full?, additionalTransform?): string

Returns transform-string for svg-export

Parameters

• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

• full?: boolean

• additionalTransform?: string = ''

Returns

string

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getSvgTransform

Defined in

src/shapes/Object/FabricObjectSVGExportMixin.ts:103

---

getTotalAngle()

getTotalAngle(): TDegree

Returns the object angle relative to canvas counting also the group property

Returns

TDegree

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getTotalAngle

Defined in

src/shapes/Object/ObjectGeometry.ts:408

---

getTotalObjectScaling()

getTotalObjectScaling(): Point

Return the object scale factor counting also the group scaling, zoom and retina

Returns

Point

object with scaleX and scaleY properties

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getTotalObjectScaling

Defined in

src/shapes/Object/Object.ts:593

---

getViewportTransform()

getViewportTransform(): TMat2D

Retrieves viewportTransform from Object’s canvas if available

Returns

TMat2D

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getViewportTransform

Defined in

src/shapes/Object/ObjectGeometry.ts:418

---

getX()

getX(): number

Returns

number

x position according to object’s originX property in canvas coordinate plane

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getX

Defined in

src/shapes/Object/ObjectGeometry.ts:86

---

getXY()

getXY(): Point

Returns

Point

x position according to object’s originX originY properties in canvas coordinate plane

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getXY

Defined in

src/shapes/Object/ObjectGeometry.ts:146

---

getY()

getY(): number

Returns

number

y position according to object’s originY property in canvas coordinate plane

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getY

Defined in

src/shapes/Object/ObjectGeometry.ts:100

---

hasCommonAncestors()

hasCommonAncestors<T>(other): boolean

Type Parameters

• T extends Group

Parameters

• other: T

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).hasCommonAncestors

Defined in

src/shapes/Object/Object.ts:1740

---

hasFill()

hasFill(): null | boolean | ""

return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time We want it to be an approximation and be fast. wrote to avoid extra caching, it has to return true when fill happens, can guess when it will not happen at 100% chance, does not matter if it misses some use case where the fill is invisible.

Returns

null | boolean | ""

Boolean

Since

3.0.0

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).hasFill

Defined in

src/shapes/Object/Object.ts:787

---

hasStroke()

hasStroke(): null | boolean | ""

return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time We want it to be an approximation and be fast. wrote to avoid extra caching, it has to return true when stroke happens, can guess when it will not happen at 100% chance, does not matter if it misses some use case where the stroke is invisible.

Returns

null | boolean | ""

Boolean

Since

3.0.0

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).hasStroke

Defined in

src/shapes/Object/Object.ts:771

---

insertAt()

insertAt(index, …objects): number

Inserts an object into collection at specified index

Parameters

• index: number

Index to insert object at

• …objects: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Object to insert

Returns

number

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).insertAt

Defined in

src/shapes/Group.ts:240

---

intersectsWithObject()

intersectsWithObject(other): boolean

Checks if object intersects with another object

Parameters

• other: ObjectGeometry<ObjectEvents>

Object to test

Returns

boolean

true if object intersects with another object

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).intersectsWithObject

Defined in

src/shapes/Object/ObjectGeometry.ts:232

---

intersectsWithRect()

intersectsWithRect(tl, br): boolean

Checks if object intersects with the scene rect formed by tl and br

Parameters

• tl: Point

• br: Point

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).intersectsWithRect

Defined in

src/shapes/Object/ObjectGeometry.ts:218

---

isCacheDirty()

isCacheDirty(skipCanvas): boolean

Check if cache is dirty

Parameters

• skipCanvas: boolean = false

skip canvas checks because this object is painted on parent canvas.

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isCacheDirty

Defined in

src/shapes/Object/Object.ts:956

---

isContainedWithinObject()

isContainedWithinObject(other): boolean

Checks if object is fully contained within area of another object

Parameters

• other: ObjectGeometry<ObjectEvents>

Object to test

Returns

boolean

true if object is fully contained within area of another object

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isContainedWithinObject

Defined in

src/shapes/Object/ObjectGeometry.ts:251

---

isContainedWithinRect()

isContainedWithinRect(tl, br): boolean

Checks if object is fully contained within the scene rect formed by tl and br

Parameters

• tl: Point

• br: Point

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isContainedWithinRect

Defined in

src/shapes/Object/ObjectGeometry.ts:259

---

isControlVisible()

isControlVisible(controlKey): boolean

Returns true if the specified control is visible, false otherwise.

Parameters

• controlKey: string

The key of the control. Possible values are usually ‘tl’, ‘tr’, ‘br’, ‘bl’, ‘ml’, ‘mt’, ‘mr’, ‘mb’, ‘mtr’, but since the control api allow for any control name, can be any string.

Returns

boolean

true if the specified control is visible, false otherwise

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isControlVisible

Defined in

src/shapes/Object/InteractiveObject.ts:584

---

isDescendantOf()

isDescendantOf(target): boolean

Checks if object is descendant of target Should be used instead of Group.contains or StaticCanvas.contains for performance reasons

Parameters

• target: TAncestor

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isDescendantOf

Defined in

src/shapes/Object/Object.ts:1644

---

isEmpty()

isEmpty(): boolean

Returns true if collection contains no objects

Returns

boolean

true if collection is empty

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isEmpty

Defined in

src/Collection.ts:128

---

isInFrontOf()

isInFrontOf<T>(other): undefined | boolean

Type Parameters

• T extends Group

Parameters

• other: T

object to compare against

Returns

undefined | boolean

if objects do not share a common ancestor or they are strictly equal it is impossible to determine which is in front of the other; in such cases the function returns undefined

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isInFrontOf

Defined in

src/shapes/Object/Object.ts:1750

---

isNotVisible()

isNotVisible(): boolean

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isNotVisible

Defined in

src/shapes/Object/Object.ts:686

---

isOnACache()

isOnACache(): boolean

Check if instance or its group are caching, recursively up

Returns

boolean

Defined in

src/shapes/Group.ts:488

---

isOnScreen()

isOnScreen(): boolean

Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen

Returns

boolean

true if object is fully or partially contained within canvas

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isOnScreen

Defined in

src/shapes/Object/ObjectGeometry.ts:291

---

isOverlapping()

isOverlapping<T>(other): boolean

Type Parameters

• T extends ObjectGeometry<ObjectEvents>

Parameters

• other: T

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isOverlapping

Defined in

src/shapes/Object/ObjectGeometry.ts:269

---

isPartiallyOnScreen()

isPartiallyOnScreen(): boolean

Checks if object is partially contained within the canvas with current viewportTransform

Returns

boolean

true if object is partially contained within canvas

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isPartiallyOnScreen

Defined in

src/shapes/Object/ObjectGeometry.ts:321

---

isType()

isType(…types): boolean

Returns true if any of the specified types is identical to the type of an instance

Parameters

• …types: string[]

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).isType

Defined in

src/shapes/Object/Object.ts:1449

---

item()

item(index): FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Returns object at specified index

Parameters

• index: number

Returns

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

object at index

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).item

Defined in

src/Collection.ts:120

---

moveObjectTo()

moveObjectTo(object, index): boolean

Moves an object to specified level in stack of drawn objects

Parameters

• object: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Object to send

• index: number

Position to move to

Returns

boolean

true if change occurred

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).moveObjectTo

Defined in

src/Collection.ts:262

---

needsItsOwnCache()

needsItsOwnCache(): boolean

When set to 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 its own isolated canvas to render correctly. Created to be overridden since 1.7.12

Returns

boolean

Boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).needsItsOwnCache

Defined in

src/shapes/Object/Object.ts:799

---

off()

off(eventName)

off<K>(eventName): void

Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. We know we should have protected events for internal flows, but we don’t have yet

Deprecated

This API is no longer supported and may be removed in a future release.

Type Parameters

• K extends keyof GroupEvents

Parameters

• eventName: K

event name (eg. ‘after:render’)

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).off

Defined in

src/Observable.ts:122

off(eventName, handler)

off<K>(eventName, handler): void

unsubscribe an event listener

Type Parameters

• K extends keyof GroupEvents

Parameters

• eventName: K

event name (eg. ‘after:render’)

• handler: TEventCallback<any>

event listener to unsubscribe

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).off

Defined in

src/Observable.ts:128

off(handlers)

off(handlers): void

unsubscribe event listeners

Parameters

• handlers: EventRegistryObject<GroupEvents>

handlers key/value pairs (eg. {‘after:render’: handler, ‘selection:cleared’: handler})

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).off

Defined in

src/Observable.ts:133

off()

off(): void

unsubscribe all event listeners

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).off

Defined in

src/Observable.ts:137

---

on()

on(eventName, handler)

on<K, E>(eventName, handler): VoidFunction

Observes specified event

Type Parameters

• K extends keyof GroupEvents

• E extends TPointerEventInfo<TPointerEvent> | TPointerEventInfo<TPointerEvent> & object | TPointerEventInfo<WheelEvent> | TPointerEventInfo<TPointerEvent> & InEvent | TPointerEventInfo<TPointerEvent> & OutEvent | Partial<TEvent<TPointerEvent>> & object | Partial<TEvent<TPointerEvent>> & object | object | object | object | TEventWithTarget<DragEvent> | DragEventData | DragEventData & InEvent | DragEventData & OutEvent | DropEventData | SimpleEventHandler<Event> | BasicTransformEvent<TPointerEvent> | BasicTransformEvent<TPointerEvent> & ModifyPathEvent | ModifiedEvent<TPointerEvent> | object | object | LayoutBeforeEvent | LayoutAfterEvent

Parameters

• eventName: K

Event name (eg. ‘after:render’)

• handler: TEventCallback<E>

Function that receives a notification when an event of the specified type occurs

Returns

VoidFunction

disposer

Alias

on

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).on

Defined in

src/Observable.ts:23

on(handlers)

on(handlers): VoidFunction

Parameters

• handlers: EventRegistryObject<GroupEvents>

Returns

VoidFunction

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).on

Defined in

src/Observable.ts:27

---

onDeselect()

onDeselect(_options?): boolean

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

Parameters

• _options?

options sent from the upper functions

• _options.e?: TPointerEvent

• _options.object?: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).onDeselect

Defined in

src/shapes/Object/InteractiveObject.ts:658

---

onDragStart()

onDragStart(_e): boolean

Override to customize Drag behavior
Fired once a drag session has started

Parameters

• _e: DragEvent

Returns

boolean

true to handle the drag event

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).onDragStart

Defined in

src/shapes/Object/InteractiveObject.ts:691

---

onSelect()

onSelect(_options?): boolean

This callback function is called every time _discardActiveObject or _setActiveObject try to to select this object. If the function returns true, the process is cancelled

Parameters

• _options?

options sent from the upper functions

• _options.e?: TPointerEvent

event if the process is generated by an event

Returns

boolean

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).onSelect

Defined in

src/shapes/Object/InteractiveObject.ts:672

---

once()

once(eventName, handler)

once<K, E>(eventName, handler): VoidFunction

Observes specified event once

Type Parameters

• K extends keyof GroupEvents

• E extends TPointerEventInfo<TPointerEvent> | TPointerEventInfo<TPointerEvent> & object | TPointerEventInfo<WheelEvent> | TPointerEventInfo<TPointerEvent> & InEvent | TPointerEventInfo<TPointerEvent> & OutEvent | Partial<TEvent<TPointerEvent>> & object | Partial<TEvent<TPointerEvent>> & object | object | object | object | TEventWithTarget<DragEvent> | DragEventData | DragEventData & InEvent | DragEventData & OutEvent | DropEventData | SimpleEventHandler<Event> | BasicTransformEvent<TPointerEvent> | BasicTransformEvent<TPointerEvent> & ModifyPathEvent | ModifiedEvent<TPointerEvent> | object | object | LayoutBeforeEvent | LayoutAfterEvent

Parameters

• eventName: K

Event name (eg. ‘after:render’)

• handler: TEventCallback<E>

Function that receives a notification when an event of the specified type occurs

Returns

VoidFunction

disposer

Alias

once

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).once

Defined in

src/Observable.ts:62

once(handlers)

once(handlers): VoidFunction

Parameters

• handlers: EventRegistryObject<GroupEvents>

Returns

VoidFunction

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).once

Defined in

src/Observable.ts:66

---

remove()

remove(…objects): FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Remove objects

Parameters

• …objects: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Returns

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

removed objects

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).remove

Defined in

src/shapes/Group.ts:252

---

removeAll()

removeAll(): FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Remove all objects

Returns

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

removed objects

Defined in

src/shapes/Group.ts:319

---

render()

render(ctx): void

Renders instance on a given context

Parameters

• ctx: CanvasRenderingContext2D

context to render instance on

Returns

void

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).render

Defined in

src/shapes/Group.ts:539

---

renderCache()

renderCache(this, options?): void

Parameters

• this: TCachedFabricObject<BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>>

• options?: any

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).renderCache

Defined in

src/shapes/Object/Object.ts:732

---

renderDragSourceEffect()

renderDragSourceEffect(_e): void

Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event example: render the selection status for the part of text that is being dragged from a text object

Parameters

• _e: DragEvent

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).renderDragSourceEffect

Defined in

src/shapes/Object/InteractiveObject.ts:712

---

renderDropTargetEffect()

renderDropTargetEffect(_e): void

Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event used to show that the underly object can receive a drop, or to show how the object will change when dropping. example: show the cursor where the text is about to be dropped

Parameters

• _e: DragEvent

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).renderDropTargetEffect

Defined in

src/shapes/Object/InteractiveObject.ts:724

---

rotate()

rotate(angle): void

Sets “angle” of an instance with centered rotation

Parameters

• angle: TDegree

Angle value (in degrees)

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).rotate

Defined in

src/shapes/Object/Object.ts:1477

---

scale()

scale(value): void

Scales an object (equally by x and y)

Parameters

• value: number

Scale factor

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).scale

Defined in

src/shapes/Object/ObjectGeometry.ts:370

---

scaleToHeight()

scaleToHeight(value): void

Scales an object to a given height, with respect to bounding box (scaling by x/y equally)

Parameters

• value: number

New height value

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).scaleToHeight

Defined in

src/shapes/Object/ObjectGeometry.ts:393

---

scaleToWidth()

scaleToWidth(value): void

Scales an object to a given width, with respect to bounding box (scaling by x/y equally)

Parameters

• value: number

New width value

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).scaleToWidth

Defined in

src/shapes/Object/ObjectGeometry.ts:381

---

sendObjectBackwards()

sendObjectBackwards(object, intersecting?): boolean

Moves an object or a selection down in stack of drawn objects An optional parameter, intersecting allows to move the object in behind the first intersecting object. Where intersection is calculated with bounding box. If no intersection is found, there will not be change in the stack.

Parameters

• object: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Object to send

• intersecting?: boolean

If true, send object behind next lower intersecting object

Returns

boolean

true if change occurred

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).sendObjectBackwards

Defined in

src/Collection.ts:214

---

sendObjectToBack()

sendObjectToBack(object): boolean

Moves an object or the objects of a multiple selection to the bottom of the stack of drawn objects

Parameters

• object: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Object to send to back

Returns

boolean

true if change occurred

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).sendObjectToBack

Defined in

src/Collection.ts:178

---

set()

set(key, value?): Group

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().

Parameters

• key: string | Record<string, any>

Property name or object (if object, iterate over the object properties)

• value?: any

Property value (if function, the value is passed into it and its return value is used as a new one)

Returns

Group

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).set

Defined in

src/CommonMethods.ts:29

---

setControlVisible()

setControlVisible(controlKey, visible): void

Sets the visibility of the specified control. please do not use.

Parameters

• controlKey: string

The key of the control. Possible values are ‘tl’, ‘tr’, ‘br’, ‘bl’, ‘ml’, ‘mt’, ‘mr’, ‘mb’, ‘mtr’. but since the control api allow for any control name, can be any string.

• visible: boolean

true to set the specified control visible, false otherwise

Returns

void

Todo

discuss this overlap of priority here with the team. Andrea Bogazzi for details

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setControlVisible

Defined in

src/shapes/Object/InteractiveObject.ts:599

---

setControlsVisibility()

setControlsVisibility(options?): void

Sets the visibility state of object controls, this is just a bulk option for setControlVisible;

Parameters

• options?: Record<string, boolean> = {}

with an optional key per control example: {Boolean} [options.bl] true to enable the bottom-left control, false to disable it

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setControlsVisibility

Defined in

src/shapes/Object/InteractiveObject.ts:611

---

setCoords()

setCoords(): void

Returns

void

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setCoords

Defined in

src/shapes/Group.ts:521

---

setOnGroup()

setOnGroup(): void

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 and value as parameters. Not adding in this function’s signature to avoid Travis build error about unused variables.

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setOnGroup

Defined in

src/shapes/Object/Object.ts:1509

---

setPositionByOrigin()

setPositionByOrigin(pos, originX, originY): void

Sets the position of the object taking into consideration the object’s origin

Parameters

• pos: Point

The new position of the object

• originX: TOriginX

Horizontal origin: ‘left’, ‘center’ or ‘right’

• originY: TOriginY

Vertical origin: ‘top’, ‘center’ or ‘bottom’

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setPositionByOrigin

Defined in

src/shapes/Object/ObjectGeometry.ts:777

---

setRelativeX()

setRelativeX(value): void

Parameters

• value: number

x position according to object’s originX property in parent’s coordinate plane
if parent is canvas then this method is identical to setX

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setRelativeX

Defined in

src/shapes/Object/ObjectGeometry.ts:123

---

setRelativeXY()

setRelativeXY(point, originX?, originY?): void

As setXY, but in current parent’s coordinate plane (the current group if any or the canvas)

Parameters

• point: Point

position according to object’s originX originY properties in parent’s coordinate plane

• originX?: TOriginX = ...

Horizontal origin: ‘left’, ‘center’ or ‘right’

• originY?: TOriginY = ...

Vertical origin: ‘top’, ‘center’ or ‘bottom’

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setRelativeXY

Defined in

src/shapes/Object/ObjectGeometry.ts:186

---

setRelativeY()

setRelativeY(value): void

Parameters

• value: number

y position according to object’s originY property in parent’s coordinate plane
if parent is canvas then this property is identical to setY

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setRelativeY

Defined in

src/shapes/Object/ObjectGeometry.ts:139

---

setX()

setX(value): void

Parameters

• value: number

x position according to object’s originX property in canvas coordinate plane

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setX

Defined in

src/shapes/Object/ObjectGeometry.ts:93

---

setXY()

setXY(point, originX?, originY?): void

Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, that otherwise are the object’s current values.

Parameters

• point: Point

position in scene coordinate plane

• originX?: TOriginX

Horizontal origin: ‘left’, ‘center’ or ‘right’

• originY?: TOriginY

Vertical origin: ‘top’, ‘center’ or ‘bottom’

Returns

void

Example

object.setXY(new Point(5, 5), 'left', 'bottom').

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setXY

Defined in

src/shapes/Object/ObjectGeometry.ts:163

---

setY()

setY(value): void

Parameters

• value: number

y position according to object’s originY property in canvas coordinate plane

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).setY

Defined in

src/shapes/Object/ObjectGeometry.ts:107

---

shouldCache()

shouldCache(): boolean

Decide if the object should cache or not. Create its own cache level needsItsOwnCache should be used when the object drawing method requires a cache step. None of the fabric classes requires it. Generally you do not cache objects in groups because the group is already cached.

Returns

boolean

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).shouldCache

Defined in

src/shapes/Group.ts:455

---

shouldStartDragging()

shouldStartDragging(_e): boolean

Override to customize Drag behavior Fired from Canvas#_onMouseMove

Parameters

• _e: TPointerEvent

Returns

boolean

true in order for the window to start a drag session

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).shouldStartDragging

Defined in

src/shapes/Object/InteractiveObject.ts:682

---

size()

size(): number

Returns a size of a collection (i.e: length of an array containing its objects)

Returns

number

Collection size

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).size

Defined in

src/Collection.ts:136

---

strokeBorders()

strokeBorders(ctx, size): void

override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style.

Parameters

• ctx: CanvasRenderingContext2D

ctx is rotated and translated so that (0,0) is at object’s center

• size: Point

the control box size used

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).strokeBorders

Defined in

src/shapes/Object/InteractiveObject.ts:399

---

toCanvasElement()

toCanvasElement(options): HTMLCanvasElement

Converts an object into a HTMLCanvas element

Parameters

• options: ObjectToCanvasElementOptions = {}

Options object

Returns

HTMLCanvasElement

Returns DOM element with the FabricObject

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).toCanvasElement

Defined in

src/shapes/Object/Object.ts:1340

---

toClipPathSVG()

toClipPathSVG(reviver?): string

Returns svg clipPath representation of an instance

Parameters

• reviver?: TSVGReviver

Method for further parsing of svg representation.

Returns

string

svg representation of an instance

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).toClipPathSVG

Defined in

src/shapes/Group.ts:666

---

toDataURL()

toDataURL(options): string

Converts an object into a data-url-like string

Parameters

• options: toDataURLOptions = {}

Options object

Returns

string

Returns a data: URL containing a representation of the object in the format specified by options.format

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).toDataURL

Defined in

src/shapes/Object/Object.ts:1436

---

toDatalessObject()

toDatalessObject(propertiesToInclude?): any

Returns (dataless) object representation of an instance

Parameters

• propertiesToInclude?: any[]

Any properties that you might want to additionally include in the output

Returns

any

Object representation of an instance

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).toDatalessObject

Defined in

src/shapes/Object/Object.ts:1884

---

toJSON()

toJSON(): any

Returns a JSON representation of an instance

Returns

any

JSON

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).toJSON

Defined in

src/shapes/Object/Object.ts:1468

---

toObject()

toObject<T, K>(propertiesToInclude?): Pick<T, K> & SerializedGroupProps

Returns object representation of an instance

Type Parameters

• T extends Omit<GroupProps & TClassProperties<Group>, keyof SerializedGroupProps>

• K extends string | number | symbol = never

Parameters

• propertiesToInclude?: K[] = []

Any properties that you might want to additionally include in the output

Returns

Pick<T, K> & SerializedGroupProps

object representation of an instance

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).toObject

Defined in

src/shapes/Group.ts:576

---

toSVG()

toSVG(this, reviver?): string

Returns svg representation of an instance

Parameters

• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

• reviver?: TSVGReviver

Method for further parsing of svg representation.

Returns

string

svg representation of an instance

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).toSVG

Defined in

src/shapes/Object/FabricObjectSVGExportMixin.ts:129

---

toString()

toString(): string

Returns a string representation of an instance

Returns

string

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).toString

Defined in

src/shapes/Group.ts:601

---

toggle()

toggle(property): Group

Toggles specified property from true to false or from false to true

Parameters

• property: string

Property to toggle

Returns

Group

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).toggle

Defined in

src/CommonMethods.ts:46

---

transform()

transform(ctx): void

Transforms context when rendering an object

Parameters

• ctx: CanvasRenderingContext2D

Context

Returns

void

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).transform

Defined in

src/shapes/Object/Object.ts:564

---

transformMatrixKey()

transformMatrixKey(skipGroup): number[]

Parameters

• skipGroup: boolean = false

Returns

number[]

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).transformMatrixKey

Defined in

src/shapes/Object/ObjectGeometry.ts:453

---

translateToCenterPoint()

translateToCenterPoint(point, originX, originY): Point

Translates the coordinates from origin to center coordinates (based on the object’s dimensions)

Parameters

• point: Point

The point which corresponds to the originX and originY params

• originX: TOriginX

Horizontal origin: ‘left’, ‘center’ or ‘right’

• originY: TOriginY

Vertical origin: ‘top’, ‘center’ or ‘bottom’

Returns

Point

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).translateToCenterPoint

Defined in

src/shapes/Object/ObjectGeometry.ts:682

---

translateToGivenOrigin()

translateToGivenOrigin(point, fromOriginX, fromOriginY, toOriginX, toOriginY): Point

Translates the coordinates from a set of origin to another (based on the object’s dimensions)

Parameters

• point: Point

The point which corresponds to the originX and originY params

• fromOriginX: TOriginX

Horizontal origin: ‘left’, ‘center’ or ‘right’

• fromOriginY: TOriginY

Vertical origin: ‘top’, ‘center’ or ‘bottom’

• toOriginX: TOriginX

Horizontal origin: ‘left’, ‘center’ or ‘right’

• toOriginY: TOriginY

Vertical origin: ‘top’, ‘center’ or ‘bottom’

Returns

Point

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).translateToGivenOrigin

Defined in

src/shapes/Object/ObjectGeometry.ts:654

---

translateToOriginPoint()

translateToOriginPoint(center, originX, originY): Point

Translates the coordinates from center to origin coordinates (based on the object’s dimensions)

Parameters

• center: Point

The point which corresponds to center of the object

• originX: TOriginX

Horizontal origin: ‘left’, ‘center’ or ‘right’

• originY: TOriginY

Vertical origin: ‘top’, ‘center’ or ‘bottom’

Returns

Point

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).translateToOriginPoint

Defined in

src/shapes/Object/ObjectGeometry.ts:710

---

triggerLayout()

triggerLayout(options): void

Parameters

• options: ImperativeLayoutOptions = {}

Returns

void

Defined in

src/shapes/Group.ts:527

---

willDrawShadow()

willDrawShadow(): boolean

Check if this object or a child object will cast a shadow

Returns

boolean

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).willDrawShadow

Defined in

src/shapes/Group.ts:472

---

_fromObject()

static _fromObject<S>(__namedParameters, __namedParameters): Promise<S>

Type Parameters

• S extends BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>

Parameters

• __namedParameters: Record<string, unknown>

• __namedParameters: Abortable & object = {}

Returns

Promise<S>

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, )._fromObject

Defined in

src/shapes/Object/Object.ts:1937

---

createControls()

static createControls(): object

Creates the default control object. If you prefer to have on instance of controls shared among all objects make this function return an empty object and add controls to the ownDefaults

Returns

object

controls

controls: Record<string, Control>

Inherited from

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).createControls

Defined in

src/shapes/Object/InteractiveObject.ts:167

---

getDefaults()

static getDefaults(): Record<string, any>

Returns

Record<string, any>

Overrides

createCollectionMixin( FabricObject<GroupProps, SerializedGroupProps, GroupEvents>, ).getDefaults

Defined in

src/shapes/Group.ts:126