BaseFabricObject

Defined in: src/shapes/Object/Object.ts:177

Root object class from which all 2d shape classes inherit from

Tutorial

http://fabricjs.com/fabric-intro-part-1#objects

Fires

added

Fires

removed

Fires

selected

Fires

deselected

Fires

rotating

Fires

scaling

Fires

moving

Fires

skewing

Fires

modified

Fires

mousedown

Fires

mouseup

Fires

mouseover

Fires

mouseout

Fires

mousewheel

Fires

mousedblclick

Fires

dragover

Fires

dragenter

Fires

dragleave

Fires

drop

Extends

• ObjectGeometry<EventSpec>

Extended by

• InteractiveFabricObject

Type Parameters

• Props extends TOptions<ObjectProps> = Partial<ObjectProps>

• SProps extends SerializedObjectProps = SerializedObjectProps

• EventSpec extends ObjectEvents = ObjectEvents

Implements

• ObjectProps

Constructors

new BaseFabricObject()

new BaseFabricObject<Props, SProps, EventSpec>(options?): BaseFabricObject<Props, SProps, EventSpec>

Defined in: src/shapes/Object/Object.ts:369

Constructor

Parameters

options?

Props

Options object

Returns

BaseFabricObject<Props, SProps, EventSpec>

Overrides

ObjectGeometry<EventSpec>.constructor

Properties

absolutePositioned

absolutePositioned: boolean

Defined in: src/shapes/Object/Object.ts:214

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

ObjectProps.absolutePositioned

---

aCoords

aCoords: TCornerPoint

Defined in: src/shapes/Object/ObjectGeometry.ts:63

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

ObjectGeometry.aCoords

---

angle

angle: TDegree

Defined in: src/shapes/Object/ObjectGeometry.ts:581

Angle of rotation of an object (in degrees)

Default

0

Implementation of

ObjectProps.angle

Inherited from

ObjectGeometry.angle

---

backgroundColor

backgroundColor: string

Defined in: src/shapes/Object/Object.ts:201

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

Default

Implementation of

ObjectProps.backgroundColor

---

centeredRotation

centeredRotation: boolean

Defined in: src/shapes/Object/Object.ts:215

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

ObjectProps.centeredRotation

---

centeredScaling

centeredScaling: boolean

Defined in: src/shapes/Object/Object.ts:216

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

ObjectProps.centeredScaling

---

clipPath?

optional clipPath: BaseFabricObject

Defined in: src/shapes/Object/Object.ts:212

Implementation of

ObjectProps.clipPath

---

dirty

dirty: boolean

Defined in: src/shapes/Object/Object.ts:241

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

Default

true

---

excludeFromExport

excludeFromExport: boolean

Defined in: src/shapes/Object/Object.ts:208

When true, object is not exported in OBJECT/JSON

Since

1.6.3

Default

Implementation of

ObjectProps.excludeFromExport

---

fill

fill: null | string | TFiller

Defined in: src/shapes/Object/Object.ts:191

Implementation of

ObjectProps.fill

---

fillRule

fillRule: CanvasFillRule

Defined in: src/shapes/Object/Object.ts:192

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

ObjectProps.fillRule

---

flipX

flipX: boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:567

When true, an object is rendered as flipped horizontally

Default

false

Implementation of

ObjectProps.flipX

Inherited from

ObjectGeometry.flipX

---

flipY

flipY: boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:568

When true, an object is rendered as flipped vertically

Default

false

Implementation of

ObjectProps.flipY

Inherited from

ObjectGeometry.flipY

---

globalCompositeOperation

globalCompositeOperation: GlobalCompositeOperation

Defined in: src/shapes/Object/Object.ts:200

Composite rule used for canvas globalCompositeOperation

Default

Implementation of

ObjectProps.globalCompositeOperation

---

height

height: number

Defined in: src/shapes/Object/ObjectGeometry.ts:566

Object height

Default

Implementation of

ObjectProps.height

Inherited from

ObjectGeometry.height

---

includeDefaultValues

includeDefaultValues: boolean

Defined in: src/shapes/Object/Object.ts:207

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

Default

Implementation of

ObjectProps.includeDefaultValues

---

inverted

inverted: boolean

Defined in: src/shapes/Object/Object.ts:213

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

ObjectProps.inverted

---

left

left: number

Defined in: src/shapes/Object/ObjectGeometry.ts:564

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

ObjectProps.left

Inherited from

ObjectGeometry.left

---

matrixCache?

optional matrixCache: TMatrixCache

Defined in: src/shapes/Object/ObjectGeometry.ts:73

storage cache for object full transform matrix

Inherited from

ObjectGeometry.matrixCache

---

minScaleLimit

minScaleLimit: number

Defined in: src/shapes/Object/Object.ts:186

Minimum allowed scale value of an object

Default

0

Implementation of

ObjectProps.minScaleLimit

---

objectCaching

objectCaching: boolean

Defined in: src/shapes/Object/Object.ts:210

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

ObjectProps.objectCaching

---

opacity

opacity: number

Defined in: src/shapes/Object/Object.ts:188

Opacity of an object

Default

1

Implementation of

ObjectProps.opacity

---

originX

originX: TOriginX

Defined in: src/shapes/Object/ObjectGeometry.ts:576

Deprecated

please use ‘center’ as value in new projects

Implementation of

ObjectProps.originX

Inherited from

ObjectGeometry.originX

---

originY

originY: TOriginY

Defined in: src/shapes/Object/ObjectGeometry.ts:580

Deprecated

please use ‘center’ as value in new projects

Implementation of

ObjectProps.originY

Inherited from

ObjectGeometry.originY

---

ownMatrixCache?

optional ownMatrixCache: TMatrixCache

Defined in: src/shapes/Object/ObjectGeometry.ts:68

storage cache for object transform matrix

Inherited from

ObjectGeometry.ownMatrixCache

---

padding

padding: number

Defined in: src/shapes/Object/ObjectGeometry.ts:53

Padding between object and its controlling borders (in pixels)

Default

0

Inherited from

ObjectGeometry.padding

---

paintFirst

paintFirst: "fill" | "stroke"

Defined in: src/shapes/Object/Object.ts:190

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

Default

Implementation of

ObjectProps.paintFirst

---

parent?

optional parent: Group

Defined in: src/shapes/Object/Object.ts:1595

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

---

scaleX

scaleX: number

Defined in: src/shapes/Object/ObjectGeometry.ts:569

Object scale factor (horizontal)

Default

1

Implementation of

ObjectProps.scaleX

Inherited from

ObjectGeometry.scaleX

---

scaleY

scaleY: number

Defined in: src/shapes/Object/ObjectGeometry.ts:570

Object scale factor (vertical)

Default

1

Implementation of

ObjectProps.scaleY

Inherited from

ObjectGeometry.scaleY

---

shadow

shadow: null | Shadow

Defined in: src/shapes/Object/Object.ts:203

Implementation of

ObjectProps.shadow

---

skewX

skewX: number

Defined in: src/shapes/Object/ObjectGeometry.ts:571

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

Default

0

Implementation of

ObjectProps.skewX

Inherited from

ObjectGeometry.skewX

---

skewY

skewY: number

Defined in: src/shapes/Object/ObjectGeometry.ts:572

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

Default

0

Implementation of

ObjectProps.skewY

Inherited from

ObjectGeometry.skewY

---

stroke

stroke: null | string | TFiller

Defined in: src/shapes/Object/Object.ts:193

Implementation of

ObjectProps.stroke

---

strokeDashArray

strokeDashArray: null | number[]

Defined in: src/shapes/Object/Object.ts:194

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

Default

null;

Implementation of

ObjectProps.strokeDashArray

---

strokeDashOffset

strokeDashOffset: number

Defined in: src/shapes/Object/Object.ts:195

Line offset of an object’s stroke

Default

0

Implementation of

ObjectProps.strokeDashOffset

---

strokeLineCap

strokeLineCap: CanvasLineCap

Defined in: src/shapes/Object/Object.ts:196

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

Default

butt

Implementation of

ObjectProps.strokeLineCap

---

strokeLineJoin

strokeLineJoin: CanvasLineJoin

Defined in: src/shapes/Object/Object.ts:197

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

Default

Implementation of

ObjectProps.strokeLineJoin

---

strokeMiterLimit

strokeMiterLimit: number

Defined in: src/shapes/Object/Object.ts:198

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

Default

4

Implementation of

ObjectProps.strokeMiterLimit

---

strokeUniform

strokeUniform: boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:583

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

ObjectProps.strokeUniform

Inherited from

ObjectGeometry.strokeUniform

---

strokeWidth

strokeWidth: number

Defined in: src/shapes/Object/ObjectGeometry.ts:582

Width of a stroke used to render this object

Default

1

Implementation of

ObjectProps.strokeWidth

Inherited from

ObjectGeometry.strokeWidth

---

top

top: number

Defined in: src/shapes/Object/ObjectGeometry.ts:563

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

ObjectProps.top

Inherited from

ObjectGeometry.top

---

visible

visible: boolean

Defined in: src/shapes/Object/Object.ts:205

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

Default

Implementation of

ObjectProps.visible

---

width

width: number

Defined in: src/shapes/Object/ObjectGeometry.ts:565

Object width

Default

Implementation of

ObjectProps.width

Inherited from

ObjectGeometry.width

---

cacheProperties

static cacheProperties: string[]

Defined in: src/shapes/Object/Object.ts:233

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

---

colorProperties

static colorProperties: string[]

Defined in: src/shapes/Object/Object.ts:1502

List of properties to consider for animating colors.

---

customProperties

static customProperties: string[] = []

Defined in: src/shapes/Object/Object.ts:1743

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

---

ownDefaults

static ownDefaults: Partial<TClassProperties<BaseFabricObject>> = fabricObjectDefaultValues

Defined in: src/shapes/Object/Object.ts:326

---

stateProperties

static stateProperties: string[]

Defined in: src/shapes/Object/Object.ts:224

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

---

type

static type: string = 'FabricObject'

Defined in: src/shapes/Object/Object.ts:342

The class type. This is used for serialization and deserialization purposes and internally it can be used to identify classes. When we transform a class in a plain JS object we need a way to recognize which class it was, and the type is the way we do that. It has no other purposes and you should not give one. Hard to reach on instances and please do not use to drive instance’s logic (this.constructor.type). To idenfity a class use instanceof class ( instanceof Rect ). We do not do that in fabricJS code because we want to try to have code splitting possible.

Accessors

type

Get Signature

get type(): string

Defined in: src/shapes/Object/Object.ts:353

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.

Returns

string

Set Signature

set type(value): void

Defined in: src/shapes/Object/Object.ts:361

Parameters

value

string

Returns

void

Methods

_drawClipPath()

_drawClipPath(ctx, clipPath, context): void

Defined in: src/shapes/Object/Object.ts:883

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

Parameters

ctx

CanvasRenderingContext2D

clipPath

undefined | BaseFabricObject

context

DrawContext

Returns

void

---

_limitCacheSize()

_limitCacheSize(dims): any

Defined in: src/shapes/Object/Object.ts:402

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

---

_removeCacheCanvas()

_removeCacheCanvas(): void

Defined in: src/shapes/Object/Object.ts:719

Remove cacheCanvas and its dimensions from the objects

Returns

void

---

_setClippingProperties()

_setClippingProperties(ctx): void

Defined in: src/shapes/Object/Object.ts:1025

Parameters

ctx

CanvasRenderingContext2D

Returns

void

---

_setFillStyles()

_setFillStyles(ctx, __namedParameters): void

Defined in: src/shapes/Object/Object.ts:1014

Parameters

ctx

CanvasRenderingContext2D

__namedParameters

Pick<BaseFabricObject<Props, SProps, EventSpec>, "fill">

Returns

void

---

_setStrokeStyles()

_setStrokeStyles(ctx, decl): void

Defined in: src/shapes/Object/Object.ts:972

Parameters

ctx

CanvasRenderingContext2D

decl

Pick<BaseFabricObject<Props, SProps, EventSpec>, "stroke" | "strokeWidth" | "strokeDashOffset" | "strokeLineCap" | "strokeLineJoin" | "strokeMiterLimit">

Returns

void

---

_setupCompositeOperation()

_setupCompositeOperation(ctx): void

Defined in: src/shapes/Object/Object.ts:1477

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

---

animate()

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

Defined in: src/shapes/Object/Object.ts:1516

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

---

calcACoords()

calcACoords(): TCornerPoint

Defined in: src/shapes/Object/ObjectGeometry.ts:427

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

ObjectGeometry.calcACoords

---

calcOwnMatrix()

calcOwnMatrix(): TMat2D

Defined in: src/shapes/Object/ObjectGeometry.ts:513

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

ObjectGeometry.calcOwnMatrix

---

calcTransformMatrix()

calcTransformMatrix(skipGroup?): TMat2D

Defined in: src/shapes/Object/ObjectGeometry.ts:485

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

ObjectGeometry.calcTransformMatrix

---

clone()

clone(propertiesToInclude?): Promise<BaseFabricObject<Props, SProps, EventSpec>>

Defined in: src/shapes/Object/Object.ts:1251

Clones an instance.

Parameters

propertiesToInclude?

string[]

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

Returns

Promise<BaseFabricObject<Props, SProps, EventSpec>>

---

cloneAsImage()

cloneAsImage(options?): FabricImage

Defined in: src/shapes/Object/Object.ts:1277

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

Object cloned as image.

Todo

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

---

complexity()

complexity(): number

Defined in: src/shapes/Object/Object.ts:1419

Returns complexity of an instance

Returns

number

complexity of this instance (is 1 unless subclassed)

---

containsPoint()

containsPoint(point): boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:282

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

ObjectGeometry.containsPoint

---

dispose()

dispose(): void

Defined in: src/shapes/Object/Object.ts:1487

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

Returns

void

---

drawCacheOnCanvas()

drawCacheOnCanvas(this, ctx): void

Defined in: src/shapes/Object/Object.ts:905

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

Parameters

this

TCachedFabricObject<BaseFabricObject>

ctx

CanvasRenderingContext2D

Context to render on

Returns

void

---

drawClipPathOnCache()

drawClipPathOnCache(ctx, clipPath, canvasWithClipPath): void

Defined in: src/shapes/Object/Object.ts:810

Execute the drawing operation for an object clipPath

Parameters

ctx

CanvasRenderingContext2D

Context to render on

clipPath

BaseFabricObject

canvasWithClipPath

HTMLCanvasElement

Returns

void

---

drawObject()

drawObject(ctx, forClipping, context): void

Defined in: src/shapes/Object/Object.ts:835

Execute the drawing operation for an object on a specified context

Parameters

ctx

CanvasRenderingContext2D

Context to render on

forClipping

apply clipping styles

undefined | boolean

context

DrawContext

additional context for rendering

Returns

void

---

drawSelectionBackground()

drawSelectionBackground(_ctx): void

Defined in: src/shapes/Object/Object.ts:691

Parameters

_ctx

CanvasRenderingContext2D

Returns

void

---

findCommonAncestors()

findCommonAncestors<T>(other): AncestryComparison

Defined in: src/shapes/Object/Object.ts:1634

Compare ancestors

Type Parameters

• T extends BaseFabricObject<Props, SProps, EventSpec>

Parameters

other

T

Returns

AncestryComparison

an object that represent the ancestry situation.

---

fire()

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

Defined in: src/Observable.ts:167

Fires event with an optional options object

Type Parameters

• K extends string | number | symbol

Parameters

eventName

K

Event name to fire

options?

EventSpec[K]

Options object

Returns

void

Inherited from

ObjectGeometry.fire

---

get()

get(property): any

Defined in: src/CommonMethods.ts:59

Basic getter

Parameters

property

string

Property name

Returns

any

value of a property

Inherited from

ObjectGeometry.get

---

getAncestors()

getAncestors(): Ancestors

Defined in: src/shapes/Object/Object.ts:1617

Returns

Ancestors

ancestors (excluding ActiveSelection) from bottom to top

---

getBoundingRect()

getBoundingRect(): TBBox

Defined in: src/shapes/Object/ObjectGeometry.ts:343

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

ObjectGeometry.getBoundingRect

---

getCanvasRetinaScaling()

getCanvasRetinaScaling(): number

Defined in: src/shapes/Object/ObjectGeometry.ts:400

Returns

number

Inherited from

ObjectGeometry.getCanvasRetinaScaling

---

getCenterPoint()

getCenterPoint(): Point

Defined in: src/shapes/Object/ObjectGeometry.ts:732

Returns the center coordinates of the object relative to canvas

Returns

Point

Inherited from

ObjectGeometry.getCenterPoint

---

getCoords()

getCoords(): Point[]

Defined in: src/shapes/Object/ObjectGeometry.ts:204

Returns

Point[]

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

Inherited from

ObjectGeometry.getCoords

---

getObjectOpacity()

getObjectOpacity(): number

Defined in: src/shapes/Object/Object.ts:570

Return the object opacity counting also the group property

Returns

number

---

getObjectScaling()

getObjectScaling(): Point

Defined in: src/shapes/Object/Object.ts:539

Return the object scale factor counting also the group scaling

Returns

Point

---

getPointByOrigin()

getPointByOrigin(originX, originY): Point

Defined in: src/shapes/Object/ObjectGeometry.ts:762

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

ObjectGeometry.getPointByOrigin

---

getRelativeCenterPoint()

getRelativeCenterPoint(): Point

Defined in: src/shapes/Object/ObjectGeometry.ts:743

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

Returns

Point

Inherited from

ObjectGeometry.getRelativeCenterPoint

---

getRelativeX()

getRelativeX(): number

Defined in: src/shapes/Object/ObjectGeometry.ts:115

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

ObjectGeometry.getRelativeX

---

getRelativeXY()

getRelativeXY(): Point

Defined in: src/shapes/Object/ObjectGeometry.ts:176

Returns

Point

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

Inherited from

ObjectGeometry.getRelativeXY

---

getRelativeY()

getRelativeY(): number

Defined in: src/shapes/Object/ObjectGeometry.ts:131

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

ObjectGeometry.getRelativeY

---

getScaledHeight()

getScaledHeight(): number

Defined in: src/shapes/Object/ObjectGeometry.ts:361

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

ObjectGeometry.getScaledHeight

---

getScaledWidth()

getScaledWidth(): number

Defined in: src/shapes/Object/ObjectGeometry.ts:352

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

ObjectGeometry.getScaledWidth

---

getTotalAngle()

getTotalAngle(): TDegree

Defined in: src/shapes/Object/ObjectGeometry.ts:408

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

Returns

TDegree

Inherited from

ObjectGeometry.getTotalAngle

---

getTotalObjectScaling()

getTotalObjectScaling(): Point

Defined in: src/shapes/Object/Object.ts:556

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

Returns

Point

object with scaleX and scaleY properties

---

getViewportTransform()

getViewportTransform(): TMat2D

Defined in: src/shapes/Object/ObjectGeometry.ts:418

Retrieves viewportTransform from Object’s canvas if available

Returns

TMat2D

Inherited from

ObjectGeometry.getViewportTransform

---

getX()

getX(): number

Defined in: src/shapes/Object/ObjectGeometry.ts:86

Returns

number

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

Inherited from

ObjectGeometry.getX

---

getXY()

getXY(): Point

Defined in: src/shapes/Object/ObjectGeometry.ts:146

Returns

Point

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

Inherited from

ObjectGeometry.getXY

---

getY()

getY(): number

Defined in: src/shapes/Object/ObjectGeometry.ts:100

Returns

number

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

Inherited from

ObjectGeometry.getY

---

hasCommonAncestors()

hasCommonAncestors<T>(other): boolean

Defined in: src/shapes/Object/Object.ts:1699

Type Parameters

• T extends BaseFabricObject<Props, SProps, EventSpec>

Parameters

other

T

Returns

boolean

---

hasFill()

hasFill(): null | boolean | ""

Defined in: src/shapes/Object/Object.ts:750

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

---

hasStroke()

hasStroke(): null | boolean | ""

Defined in: src/shapes/Object/Object.ts:734

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

---

intersectsWithObject()

intersectsWithObject(other): boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:232

Checks if object intersects with another object

Parameters

other

ObjectGeometry

Object to test

Returns

boolean

true if object intersects with another object

Inherited from

ObjectGeometry.intersectsWithObject

---

intersectsWithRect()

intersectsWithRect(tl, br): boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:218

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

Parameters

tl

Point

br

Point

Returns

boolean

Inherited from

ObjectGeometry.intersectsWithRect

---

isCacheDirty()

isCacheDirty(skipCanvas): boolean

Defined in: src/shapes/Object/Object.ts:919

Check if cache is dirty

Parameters

skipCanvas

boolean = false

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

Returns

boolean

---

isContainedWithinObject()

isContainedWithinObject(other): boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:251

Checks if object is fully contained within area of another object

Parameters

other

ObjectGeometry

Object to test

Returns

boolean

true if object is fully contained within area of another object

Inherited from

ObjectGeometry.isContainedWithinObject

---

isContainedWithinRect()

isContainedWithinRect(tl, br): boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:259

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

Parameters

tl

Point

br

Point

Returns

boolean

Inherited from

ObjectGeometry.isContainedWithinRect

---

isDescendantOf()

isDescendantOf(target): boolean

Defined in: src/shapes/Object/Object.ts:1603

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

---

isInFrontOf()

isInFrontOf<T>(other): undefined | boolean

Defined in: src/shapes/Object/Object.ts:1709

Type Parameters

• T extends BaseFabricObject<Props, SProps, EventSpec>

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

---

isNotVisible()

isNotVisible(): boolean

Defined in: src/shapes/Object/Object.ts:649

Returns

boolean

---

isOnScreen()

isOnScreen(): boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:291

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

ObjectGeometry.isOnScreen

---

isOverlapping()

isOverlapping<T>(other): boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:269

Type Parameters

• T extends ObjectGeometry

Parameters

other

T

Returns

boolean

Inherited from

ObjectGeometry.isOverlapping

---

isPartiallyOnScreen()

isPartiallyOnScreen(): boolean

Defined in: src/shapes/Object/ObjectGeometry.ts:321

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

Returns

boolean

true if object is partially contained within canvas

Inherited from

ObjectGeometry.isPartiallyOnScreen

---

isType()

isType(…types): boolean

Defined in: src/shapes/Object/Object.ts:1408

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

Parameters

types

…string[]

Returns

boolean

---

needsItsOwnCache()

needsItsOwnCache(): boolean

Defined in: src/shapes/Object/Object.ts:762

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

---

off()

Call Signature

off<K>(eventName): void

Defined in: src/Observable.ts:122

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 string | number | symbol

Parameters

eventName

K

event name (eg. ‘after:render’)

Returns

void

Inherited from

ObjectGeometry.off

Call Signature

off<K>(eventName, handler): void

Defined in: src/Observable.ts:128

unsubscribe an event listener

Type Parameters

• K extends string | number | symbol

Parameters

eventName

K

event name (eg. ‘after:render’)

handler

TEventCallback<any>

event listener to unsubscribe

Returns

void

Inherited from

ObjectGeometry.off

Call Signature

off(handlers): void

Defined in: src/Observable.ts:133

unsubscribe event listeners

Parameters

handlers

EventRegistryObject<EventSpec>

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

Returns

void

Inherited from

ObjectGeometry.off

Call Signature

off(): void

Defined in: src/Observable.ts:137

unsubscribe all event listeners

Returns

void

Inherited from

ObjectGeometry.off

---

on()

Call Signature

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

Defined in: src/Observable.ts:23

Observes specified event

Type Parameters

• K extends string | number | symbol

• E

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

ObjectGeometry.on

Call Signature

on(handlers): VoidFunction

Defined in: src/Observable.ts:27

Observes specified event

Parameters

handlers

EventRegistryObject<EventSpec>

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

Returns

VoidFunction

disposer

Alias

on

Inherited from

ObjectGeometry.on

---

once()

Call Signature

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

Defined in: src/Observable.ts:62

Observes specified event once

Type Parameters

• K extends string | number | symbol

• E

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

ObjectGeometry.once

Call Signature

once(handlers): VoidFunction

Defined in: src/Observable.ts:66

Observes specified event once

Parameters

handlers

EventRegistryObject<EventSpec>

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

Returns

VoidFunction

disposer

Alias

once

Inherited from

ObjectGeometry.once

---

render()

render(ctx): void

Defined in: src/shapes/Object/Object.ts:661

Renders an object on a specified context

Parameters

ctx

CanvasRenderingContext2D

Context to render on

Returns

void

---

renderCache()

renderCache(this, options?): void

Defined in: src/shapes/Object/Object.ts:695

Parameters

this

TCachedFabricObject<BaseFabricObject>

options?

any

Returns

void

---

rotate()

rotate(angle): void

Defined in: src/shapes/Object/Object.ts:1436

Sets “angle” of an instance with centered rotation

Parameters

angle

TDegree

Angle value (in degrees)

Returns

void

---

scale()

scale(value): void

Defined in: src/shapes/Object/ObjectGeometry.ts:370

Scales an object (equally by x and y)

Parameters

value

number

Scale factor

Returns

void

Inherited from

ObjectGeometry.scale

---

scaleToHeight()

scaleToHeight(value): void

Defined in: src/shapes/Object/ObjectGeometry.ts:393

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

ObjectGeometry.scaleToHeight

---

scaleToWidth()

scaleToWidth(value): void

Defined in: src/shapes/Object/ObjectGeometry.ts:381

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

ObjectGeometry.scaleToWidth

---

set()

set(key, value?): BaseFabricObject<Props, SProps, EventSpec>

Defined in: src/CommonMethods.ts:29

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

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

string | Record<string, any>

value?

any

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

Returns

BaseFabricObject<Props, SProps, EventSpec>

Inherited from

ObjectGeometry.set

---

setCoords()

setCoords(): void

Defined in: src/shapes/Object/ObjectGeometry.ts:449

Sets corner and controls position coordinates based on current angle, width and height, left and top. aCoords are used to quickly find an object on the canvas. See https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords and http://fabricjs.com/fabric-gotchas

Returns

void

Inherited from

ObjectGeometry.setCoords

---

setOnGroup()

setOnGroup(): void

Defined in: src/shapes/Object/Object.ts:1468

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

---

setPositionByOrigin()

setPositionByOrigin(pos, originX, originY): void

Defined in: src/shapes/Object/ObjectGeometry.ts:777

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

ObjectGeometry.setPositionByOrigin

---

setRelativeX()

setRelativeX(value): void

Defined in: src/shapes/Object/ObjectGeometry.ts:123

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

ObjectGeometry.setRelativeX

---

setRelativeXY()

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

Defined in: src/shapes/Object/ObjectGeometry.ts:186

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

ObjectGeometry.setRelativeXY

---

setRelativeY()

setRelativeY(value): void

Defined in: src/shapes/Object/ObjectGeometry.ts:139

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

ObjectGeometry.setRelativeY

---

setX()

setX(value): void

Defined in: src/shapes/Object/ObjectGeometry.ts:93

Parameters

value

number

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

Returns

void

Inherited from

ObjectGeometry.setX

---

setXY()

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

Defined in: src/shapes/Object/ObjectGeometry.ts:163

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

ObjectGeometry.setXY

---

setY()

setY(value): void

Defined in: src/shapes/Object/ObjectGeometry.ts:107

Parameters

value

number

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

Returns

void

Inherited from

ObjectGeometry.setY

---

shouldCache()

shouldCache(): boolean

Defined in: src/shapes/Object/Object.ts:786

Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything needsItsOwnCache should be used when the object drawing method requires a cache step. None of the fabric classes requires it. Generally you do not cache objects in groups because the group outside is cached. Read as: cache if is needed, or if the feature is enabled but we are not already caching.

Returns

boolean

---

toCanvasElement()

toCanvasElement(options): HTMLCanvasElement

Defined in: src/shapes/Object/Object.ts:1299

Converts an object into a HTMLCanvas element

Parameters

options

ObjectToCanvasElementOptions = {}

Options object

Returns

HTMLCanvasElement

Returns DOM element with the FabricObject

---

toDatalessObject()

toDatalessObject(propertiesToInclude?): any

Defined in: src/shapes/Object/Object.ts:1843

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

---

toDataURL()

toDataURL(options): string

Defined in: src/shapes/Object/Object.ts:1395

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

---

toggle()

toggle(property): BaseFabricObject<Props, SProps, EventSpec>

Defined in: src/CommonMethods.ts:46

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

Parameters

property

string

Property to toggle

Returns

BaseFabricObject<Props, SProps, EventSpec>

Inherited from

ObjectGeometry.toggle

---

toJSON()

toJSON(): any

Defined in: src/shapes/Object/Object.ts:1427

Returns a JSON representation of an instance

Returns

any

JSON

---

toObject()

toObject(propertiesToInclude?): any

Defined in: src/shapes/Object/Object.ts:1750

Returns an 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

---

toString()

toString(): string

Defined in: src/shapes/Object/Object.ts:1883

Returns a string representation of an instance

Returns

string

---

transform()

transform(ctx): void

Defined in: src/shapes/Object/Object.ts:527

Transforms context when rendering an object

Parameters

ctx

CanvasRenderingContext2D

Context

Returns

void

---

transformMatrixKey()

transformMatrixKey(skipGroup): number[]

Defined in: src/shapes/Object/ObjectGeometry.ts:453

Parameters

skipGroup

boolean = false

Returns

number[]

Inherited from

ObjectGeometry.transformMatrixKey

---

translateToCenterPoint()

translateToCenterPoint(point, originX, originY): Point

Defined in: src/shapes/Object/ObjectGeometry.ts:682

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

ObjectGeometry.translateToCenterPoint

---

translateToGivenOrigin()

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

Defined in: src/shapes/Object/ObjectGeometry.ts:654

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

ObjectGeometry.translateToGivenOrigin

---

translateToOriginPoint()

translateToOriginPoint(center, originX, originY): Point

Defined in: src/shapes/Object/ObjectGeometry.ts:710

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

ObjectGeometry.translateToOriginPoint

---

willDrawShadow()

willDrawShadow(): boolean

Defined in: src/shapes/Object/Object.ts:799

Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively

Deprecated

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

Returns

boolean

---

_fromObject()

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

Defined in: src/shapes/Object/Object.ts:1896

Type Parameters

• S extends BaseFabricObject

Parameters

__namedParameters

Record<string, unknown>

__namedParameters

Abortable & object = {}

Returns

Promise<S>

---

fromObject()

static fromObject<T>(object, options?): Promise<BaseFabricObject>

Defined in: src/shapes/Object/Object.ts:1925

Type Parameters

• T extends TOptions<SerializedObjectProps>

Parameters

object

T

options?

Abortable

Returns

Promise<BaseFabricObject>

---

getDefaults()

static getDefaults(): Record<string, any>

Defined in: src/shapes/Object/Object.ts:328

Returns

Record<string, any>