BaseFabricObject
Defined in: src/shapes/Object/Object.ts:178
Root object class from which all 2d shape classes inherit from
Tutorial
Section titled “Tutorial”http://fabricjs.com/fabric-intro-part-1#objects
added
removed
selected
deselected
rotating
scaling
moving
skewing
modified
mousedown
mouseup
mouseover
mouseout
mousewheel
mousedblclick
dragover
dragenter
dragleave
drop
Extends
Section titled “Extends”ObjectGeometry<EventSpec>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”Props extends TOptions<ObjectProps> = Partial<ObjectProps>
SProps
Section titled “SProps”SProps extends SerializedObjectProps = SerializedObjectProps
EventSpec
Section titled “EventSpec”EventSpec extends ObjectEvents = ObjectEvents
Implements
Section titled “Implements”ObjectProps
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseFabricObject<
Props,SProps,EventSpec>(options?):FabricObject<Props,SProps,EventSpec>
Defined in: src/shapes/Object/Object.ts:370
Constructor
Parameters
Section titled “Parameters”options?
Section titled “options?”Props
Options object
Returns
Section titled “Returns”FabricObject<Props, SProps, EventSpec>
Overrides
Section titled “Overrides”ObjectGeometry<EventSpec>.constructor
Properties
Section titled “Properties”absolutePositioned
Section titled “absolutePositioned”absolutePositioned:
boolean
Defined in: src/shapes/Object/Object.ts:215
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
Section titled “Default”falseImplementation of
Section titled “Implementation of”ObjectProps.absolutePositioned
aCoords
Section titled “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
Section titled “Inherited from”ObjectGeometry.aCoords
angle:
TDegree
Defined in: src/shapes/Object/ObjectGeometry.ts:583
Angle of rotation of an object (in degrees)
Default
Section titled “Default”0Implementation of
Section titled “Implementation of”ObjectProps.angle
Inherited from
Section titled “Inherited from”ObjectGeometry.angle
backgroundColor
Section titled “backgroundColor”backgroundColor:
string
Defined in: src/shapes/Object/Object.ts:202
Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.backgroundColor
centeredRotation
Section titled “centeredRotation”centeredRotation:
boolean
Defined in: src/shapes/Object/Object.ts:216
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.
1.3.4
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.centeredRotation
centeredScaling
Section titled “centeredScaling”centeredScaling:
boolean
Defined in: src/shapes/Object/Object.ts:217
When true, this object will use center point as the origin of transformation when being scaled via the controls.
1.3.4
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.centeredScaling
clipPath?
Section titled “clipPath?”
optionalclipPath:FabricObject<Partial<ObjectProps>,SerializedObjectProps,ObjectEvents>
Defined in: src/shapes/Object/Object.ts:213
Implementation of
Section titled “Implementation of”ObjectProps.clipPath
dirty:
boolean
Defined in: src/shapes/Object/Object.ts:242
When set to true, object’s cache will be rerendered next render call.
since 1.7.0
Default
Section titled “Default”trueexcludeFromExport
Section titled “excludeFromExport”excludeFromExport:
boolean
Defined in: src/shapes/Object/Object.ts:209
When true, object is not exported in OBJECT/JSON
1.6.3
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.excludeFromExport
fill:
null|string|TFiller
Defined in: src/shapes/Object/Object.ts:192
Implementation of
Section titled “Implementation of”ObjectProps.fill
fillRule
Section titled “fillRule”fillRule:
CanvasFillRule
Defined in: src/shapes/Object/Object.ts:193
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
Section titled “Default”nonzeroImplementation of
Section titled “Implementation of”ObjectProps.fillRule
flipX:
boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:569
When true, an object is rendered as flipped horizontally
Default
Section titled “Default”falseImplementation of
Section titled “Implementation of”ObjectProps.flipX
Inherited from
Section titled “Inherited from”ObjectGeometry.flipX
flipY:
boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:570
When true, an object is rendered as flipped vertically
Default
Section titled “Default”falseImplementation of
Section titled “Implementation of”ObjectProps.flipY
Inherited from
Section titled “Inherited from”ObjectGeometry.flipY
globalCompositeOperation
Section titled “globalCompositeOperation”globalCompositeOperation:
GlobalCompositeOperation
Defined in: src/shapes/Object/Object.ts:201
Composite rule used for canvas globalCompositeOperation
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.globalCompositeOperation
height
Section titled “height”height:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:568
Object height
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.height
Inherited from
Section titled “Inherited from”ObjectGeometry.height
includeDefaultValues
Section titled “includeDefaultValues”includeDefaultValues:
boolean
Defined in: src/shapes/Object/Object.ts:208
When false, default object’s values are not included in its serialization
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.includeDefaultValues
inverted
Section titled “inverted”inverted:
boolean
Defined in: src/shapes/Object/Object.ts:214
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
Section titled “Default”falseImplementation of
Section titled “Implementation of”ObjectProps.inverted
left:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:566
Left position of an object. Note that by default it’s relative to object left. You can change this by setting FabricObject#originX
Default
Section titled “Default”0Implementation of
Section titled “Implementation of”ObjectProps.left
Inherited from
Section titled “Inherited from”ObjectGeometry.left
matrixCache?
Section titled “matrixCache?”
optionalmatrixCache:TMatrixCache
Defined in: src/shapes/Object/ObjectGeometry.ts:73
storage cache for object full transform matrix
Inherited from
Section titled “Inherited from”ObjectGeometry.matrixCache
minScaleLimit
Section titled “minScaleLimit”minScaleLimit:
number
Defined in: src/shapes/Object/Object.ts:187
Minimum allowed scale value of an object
Default
Section titled “Default”0Implementation of
Section titled “Implementation of”ObjectProps.minScaleLimit
objectCaching
Section titled “objectCaching”objectCaching:
boolean
Defined in: src/shapes/Object/Object.ts:211
When true, object is cached on an additional canvas.
When false, object is not cached unless necessary ( clipPath )
default to true
1.7.0
Default
Section titled “Default”trueImplementation of
Section titled “Implementation of”ObjectProps.objectCaching
opacity
Section titled “opacity”opacity:
number
Defined in: src/shapes/Object/Object.ts:189
Opacity of an object
Default
Section titled “Default”1Implementation of
Section titled “Implementation of”ObjectProps.opacity
originX
Section titled “originX”originX:
TOriginX
Defined in: src/shapes/Object/ObjectGeometry.ts:578
Implementation of
Section titled “Implementation of”ObjectProps.originX
Inherited from
Section titled “Inherited from”ObjectGeometry.originX
originY
Section titled “originY”originY:
TOriginY
Defined in: src/shapes/Object/ObjectGeometry.ts:582
Implementation of
Section titled “Implementation of”ObjectProps.originY
Inherited from
Section titled “Inherited from”ObjectGeometry.originY
ownMatrixCache?
Section titled “ownMatrixCache?”
optionalownMatrixCache:TMatrixCache
Defined in: src/shapes/Object/ObjectGeometry.ts:68
storage cache for object transform matrix
Inherited from
Section titled “Inherited from”ObjectGeometry.ownMatrixCache
padding
Section titled “padding”padding:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:53
Padding between object and its controlling borders (in pixels)
Default
Section titled “Default”0Inherited from
Section titled “Inherited from”ObjectGeometry.padding
paintFirst
Section titled “paintFirst”paintFirst:
"fill"|"stroke"
Defined in: src/shapes/Object/Object.ts:191
Determines if the fill or the stroke is drawn first (one of “fill” or “stroke”)
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.paintFirst
parent?
Section titled “parent?”
optionalparent:Group
Defined in: src/shapes/Object/Object.ts:1606
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
Section titled “scaleX”scaleX:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:571
Object scale factor (horizontal)
Default
Section titled “Default”1Implementation of
Section titled “Implementation of”ObjectProps.scaleX
Inherited from
Section titled “Inherited from”ObjectGeometry.scaleX
scaleY
Section titled “scaleY”scaleY:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:572
Object scale factor (vertical)
Default
Section titled “Default”1Implementation of
Section titled “Implementation of”ObjectProps.scaleY
Inherited from
Section titled “Inherited from”ObjectGeometry.scaleY
shadow
Section titled “shadow”shadow:
null|Shadow
Defined in: src/shapes/Object/Object.ts:204
Implementation of
Section titled “Implementation of”ObjectProps.shadow
skewX:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:573
Angle of skew on x axes of an object (in degrees)
Default
Section titled “Default”0Implementation of
Section titled “Implementation of”ObjectProps.skewX
Inherited from
Section titled “Inherited from”ObjectGeometry.skewX
skewY:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:574
Angle of skew on y axes of an object (in degrees)
Default
Section titled “Default”0Implementation of
Section titled “Implementation of”ObjectProps.skewY
Inherited from
Section titled “Inherited from”ObjectGeometry.skewY
stroke
Section titled “stroke”stroke:
null|string|TFiller
Defined in: src/shapes/Object/Object.ts:194
Implementation of
Section titled “Implementation of”ObjectProps.stroke
strokeDashArray
Section titled “strokeDashArray”strokeDashArray:
null|number[]
Defined in: src/shapes/Object/Object.ts:195
Array specifying dash pattern of an object’s stroke (stroke must be defined)
Default
Section titled “Default”null;Implementation of
Section titled “Implementation of”ObjectProps.strokeDashArray
strokeDashOffset
Section titled “strokeDashOffset”strokeDashOffset:
number
Defined in: src/shapes/Object/Object.ts:196
Line offset of an object’s stroke
Default
Section titled “Default”0Implementation of
Section titled “Implementation of”ObjectProps.strokeDashOffset
strokeLineCap
Section titled “strokeLineCap”strokeLineCap:
CanvasLineCap
Defined in: src/shapes/Object/Object.ts:197
Line endings style of an object’s stroke (one of “butt”, “round”, “square”)
Default
Section titled “Default”buttImplementation of
Section titled “Implementation of”ObjectProps.strokeLineCap
strokeLineJoin
Section titled “strokeLineJoin”strokeLineJoin:
CanvasLineJoin
Defined in: src/shapes/Object/Object.ts:198
Corner style of an object’s stroke (one of “bevel”, “round”, “miter”)
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.strokeLineJoin
strokeMiterLimit
Section titled “strokeMiterLimit”strokeMiterLimit:
number
Defined in: src/shapes/Object/Object.ts:199
Maximum miter length (used for strokeLineJoin = “miter”) of an object’s stroke
Default
Section titled “Default”4Implementation of
Section titled “Implementation of”ObjectProps.strokeMiterLimit
strokeUniform
Section titled “strokeUniform”strokeUniform:
boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:585
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
2.6.0
Default
Section titled “Default”falseDefault
Section titled “Default”falseImplementation of
Section titled “Implementation of”ObjectProps.strokeUniform
Inherited from
Section titled “Inherited from”ObjectGeometry.strokeUniform
strokeWidth
Section titled “strokeWidth”strokeWidth:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:584
Width of a stroke used to render this object
Default
Section titled “Default”1Implementation of
Section titled “Implementation of”ObjectProps.strokeWidth
Inherited from
Section titled “Inherited from”ObjectGeometry.strokeWidth
top:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:565
Top position of an object. Note that by default it’s relative to object top. You can change this by setting FabricObject#originY
Default
Section titled “Default”0Implementation of
Section titled “Implementation of”ObjectProps.top
Inherited from
Section titled “Inherited from”ObjectGeometry.top
visible
Section titled “visible”visible:
boolean
Defined in: src/shapes/Object/Object.ts:206
When set to false, an object is not rendered on canvas
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.visible
width:
number
Defined in: src/shapes/Object/ObjectGeometry.ts:567
Object width
Default
Section titled “Default”Implementation of
Section titled “Implementation of”ObjectProps.width
Inherited from
Section titled “Inherited from”ObjectGeometry.width
cacheProperties
Section titled “cacheProperties”
staticcacheProperties:string[]
Defined in: src/shapes/Object/Object.ts:234
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
Section titled “colorProperties”
staticcolorProperties:string[]
Defined in: src/shapes/Object/Object.ts:1513
List of properties to consider for animating colors.
customProperties
Section titled “customProperties”
staticcustomProperties:string[] =[]
Defined in: src/shapes/Object/Object.ts:1754
Define a list of custom properties that will be serialized when instance.toObject() gets called
ownDefaults
Section titled “ownDefaults”
staticownDefaults:Partial<TClassProperties<FabricObject<Partial<ObjectProps>,SerializedObjectProps,ObjectEvents>>> =fabricObjectDefaultValues
Defined in: src/shapes/Object/Object.ts:327
stateProperties
Section titled “stateProperties”
staticstateProperties:string[]
Defined in: src/shapes/Object/Object.ts:225
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
statictype:string='FabricObject'
Defined in: src/shapes/Object/Object.ts:343
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
Section titled “Accessors”Get Signature
Section titled “Get Signature”get type():
string
Defined in: src/shapes/Object/Object.ts:354
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
add sustainable warning message
Returns
Section titled “Returns”string
Set Signature
Section titled “Set Signature”set type(
value):void
Defined in: src/shapes/Object/Object.ts:362
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Methods
Section titled “Methods”_drawClipPath()
Section titled “_drawClipPath()”_drawClipPath(
ctx,clipPath,context):void
Defined in: src/shapes/Object/Object.ts:884
Prepare clipPath state and cache and draw it on instance’s cache
Parameters
Section titled “Parameters”CanvasRenderingContext2D
clipPath
Section titled “clipPath”undefined | FabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>
context
Section titled “context”Returns
Section titled “Returns”void
_limitCacheSize()
Section titled “_limitCacheSize()”_limitCacheSize(
dims):any
Defined in: src/shapes/Object/Object.ts:403
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
Section titled “Parameters”any
Returns
Section titled “Returns”any
.width width of canvas
_removeCacheCanvas()
Section titled “_removeCacheCanvas()”_removeCacheCanvas():
void
Defined in: src/shapes/Object/Object.ts:720
Remove cacheCanvas and its dimensions from the objects
Returns
Section titled “Returns”void
_setClippingProperties()
Section titled “_setClippingProperties()”_setClippingProperties(
ctx):void
Defined in: src/shapes/Object/Object.ts:1029
Parameters
Section titled “Parameters”CanvasRenderingContext2D
Returns
Section titled “Returns”void
_setFillStyles()
Section titled “_setFillStyles()”_setFillStyles(
ctx,__namedParameters):void
Defined in: src/shapes/Object/Object.ts:1018
Parameters
Section titled “Parameters”CanvasRenderingContext2D
__namedParameters
Section titled “__namedParameters”Pick<FabricObject<Props, SProps, EventSpec>, "fill">
Returns
Section titled “Returns”void
_setStrokeStyles()
Section titled “_setStrokeStyles()”_setStrokeStyles(
ctx,decl):void
Defined in: src/shapes/Object/Object.ts:976
Parameters
Section titled “Parameters”CanvasRenderingContext2D
Pick<FabricObject<Props, SProps, EventSpec>, "stroke" | "strokeWidth" | "strokeDashOffset" | "strokeLineCap" | "strokeLineJoin" | "strokeMiterLimit">
Returns
Section titled “Returns”void
_setupCompositeOperation()
Section titled “_setupCompositeOperation()”_setupCompositeOperation(
ctx):void
Defined in: src/shapes/Object/Object.ts:1488
Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property
Parameters
Section titled “Parameters”CanvasRenderingContext2D
Rendering canvas context
Returns
Section titled “Returns”void
animate()
Section titled “animate()”animate<
T>(animatable,options?):Record<string,TAnimation<T>>
Defined in: src/shapes/Object/Object.ts:1527
Animates object’s properties
Type Parameters
Section titled “Type Parameters”T extends number | number[] | TColorArg
Parameters
Section titled “Parameters”animatable
Section titled “animatable”Record<string, T>
map of keys and end values
options?
Section titled “options?”Partial<AnimationOptions<T>>
Returns
Section titled “Returns”Record<string, TAnimation<T>>
map of animation contexts
As object — multiple properties
object.animate({ left: …, top: … }); object.animate({ left: …, top: … }, { duration: … });
Tutorial
Section titled “Tutorial”http://fabricjs.com/fabric-intro-part-2#animation
calcACoords()
Section titled “calcACoords()”calcACoords():
TCornerPoint
Defined in: src/shapes/Object/ObjectGeometry.ts:429
Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes.
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ObjectGeometry.calcACoords
calcOwnMatrix()
Section titled “calcOwnMatrix()”calcOwnMatrix():
TMat2D
Defined in: src/shapes/Object/ObjectGeometry.ts:515
calculate transform matrix that represents the current transformations from the object’s properties, this matrix does not include the group transformation
Returns
Section titled “Returns”transform matrix for the object
Inherited from
Section titled “Inherited from”ObjectGeometry.calcOwnMatrix
calcTransformMatrix()
Section titled “calcTransformMatrix()”calcTransformMatrix(
skipGroup?):TMat2D
Defined in: src/shapes/Object/ObjectGeometry.ts:487
calculate transform matrix that represents the current transformations from the object’s properties.
Parameters
Section titled “Parameters”skipGroup?
Section titled “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
Section titled “Returns”transform matrix for the object
Inherited from
Section titled “Inherited from”ObjectGeometry.calcTransformMatrix
clone()
Section titled “clone()”clone(
propertiesToInclude?):Promise<FabricObject<Props,SProps,EventSpec>>
Defined in: src/shapes/Object/Object.ts:1255
Clones an instance.
Parameters
Section titled “Parameters”propertiesToInclude?
Section titled “propertiesToInclude?”string[]
Any properties that you might want to additionally include in the output
Returns
Section titled “Returns”Promise<FabricObject<Props, SProps, EventSpec>>
cloneAsImage()
Section titled “cloneAsImage()”cloneAsImage(
options?):FabricImage
Defined in: src/shapes/Object/Object.ts:1281
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
Section titled “Parameters”options?
Section titled “options?”ObjectToCanvasElementOptions
for clone as image, passed to toDataURL
Returns
Section titled “Returns”Object cloned as image.
fix the export type, it could not be Image but the type that getClass return for ‘image’.
complexity()
Section titled “complexity()”complexity():
number
Defined in: src/shapes/Object/Object.ts:1430
Returns complexity of an instance
Returns
Section titled “Returns”number
complexity of this instance (is 1 unless subclassed)
containsPoint()
Section titled “containsPoint()”containsPoint(
point):boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:284
Checks if point is inside the object
Parameters
Section titled “Parameters”Point to check against
Returns
Section titled “Returns”boolean
true if point is inside the object
Inherited from
Section titled “Inherited from”ObjectGeometry.containsPoint
dispose()
Section titled “dispose()”dispose():
void
Defined in: src/shapes/Object/Object.ts:1498
cancel instance’s running animations
override if necessary to dispose artifacts such as clipPath
Returns
Section titled “Returns”void
drawCacheOnCanvas()
Section titled “drawCacheOnCanvas()”drawCacheOnCanvas(
this,ctx):void
Defined in: src/shapes/Object/Object.ts:906
Paint the cached copy of the object on the target context.
Parameters
Section titled “Parameters”TCachedFabricObject
CanvasRenderingContext2D
Context to render on
Returns
Section titled “Returns”void
drawClipPathOnCache()
Section titled “drawClipPathOnCache()”drawClipPathOnCache(
ctx,clipPath,canvasWithClipPath):void
Defined in: src/shapes/Object/Object.ts:812
Execute the drawing operation for an object clipPath
Parameters
Section titled “Parameters”CanvasRenderingContext2D
Context to render on
clipPath
Section titled “clipPath”FabricObject
canvasWithClipPath
Section titled “canvasWithClipPath”HTMLCanvasElement
Returns
Section titled “Returns”void
drawObject()
Section titled “drawObject()”drawObject(
ctx,forClipping,context):void
Defined in: src/shapes/Object/Object.ts:836
Execute the drawing operation for an object on a specified context
Parameters
Section titled “Parameters”CanvasRenderingContext2D
Context to render on
forClipping
Section titled “forClipping”apply clipping styles
undefined | boolean
context
Section titled “context”additional context for rendering
Returns
Section titled “Returns”void
drawSelectionBackground()
Section titled “drawSelectionBackground()”drawSelectionBackground(
_ctx):void
Defined in: src/shapes/Object/Object.ts:692
Parameters
Section titled “Parameters”CanvasRenderingContext2D
Returns
Section titled “Returns”void
findCommonAncestors()
Section titled “findCommonAncestors()”findCommonAncestors<
T>(other):AncestryComparison
Defined in: src/shapes/Object/Object.ts:1645
Compare ancestors
Type Parameters
Section titled “Type Parameters”T extends FabricObject<Props, SProps, EventSpec>
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”AncestryComparison
an object that represent the ancestry situation.
fire()
Section titled “fire()”fire<
K>(eventName,options?):void
Defined in: src/Observable.ts:167
Fires event with an optional options object
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
Event name to fire
options?
Section titled “options?”EventSpec[K]
Options object
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.fire
get(
property):any
Defined in: src/CommonMethods.ts:59
Basic getter
Parameters
Section titled “Parameters”property
Section titled “property”string
Property name
Returns
Section titled “Returns”any
value of a property
Inherited from
Section titled “Inherited from”ObjectGeometry.get
getAncestors()
Section titled “getAncestors()”getAncestors():
Ancestors
Defined in: src/shapes/Object/Object.ts:1628
Returns
Section titled “Returns”Ancestors
ancestors (excluding ActiveSelection) from bottom to top
getBoundingRect()
Section titled “getBoundingRect()”getBoundingRect():
TBBox
Defined in: src/shapes/Object/ObjectGeometry.ts:345
Returns coordinates of object’s bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas.
Returns
Section titled “Returns”Object with left, top, width, height properties
Inherited from
Section titled “Inherited from”ObjectGeometry.getBoundingRect
getCanvasRetinaScaling()
Section titled “getCanvasRetinaScaling()”getCanvasRetinaScaling():
number
Defined in: src/shapes/Object/ObjectGeometry.ts:402
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”ObjectGeometry.getCanvasRetinaScaling
getCenterPoint()
Section titled “getCenterPoint()”getCenterPoint():
Point
Defined in: src/shapes/Object/ObjectGeometry.ts:735
Returns the center coordinates of the object relative to canvas
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ObjectGeometry.getCenterPoint
getCoords()
Section titled “getCoords()”getCoords():
Point[]
Defined in: src/shapes/Object/ObjectGeometry.ts:204
Returns
Section titled “Returns”Point[]
[tl, tr, br, bl] in the scene plane
Inherited from
Section titled “Inherited from”ObjectGeometry.getCoords
getObjectOpacity()
Section titled “getObjectOpacity()”getObjectOpacity():
number
Defined in: src/shapes/Object/Object.ts:571
Return the object opacity counting also the group property
Returns
Section titled “Returns”number
getObjectScaling()
Section titled “getObjectScaling()”getObjectScaling():
Point
Defined in: src/shapes/Object/Object.ts:540
Return the object scale factor counting also the group scaling
Returns
Section titled “Returns”getPointByOrigin()
Section titled “getPointByOrigin()”getPointByOrigin(
originX,originY):Point
Defined in: src/shapes/Object/ObjectGeometry.ts:765
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
Section titled “Parameters”originX
Section titled “originX”Horizontal origin: ‘left’, ‘center’ or ‘right’
originY
Section titled “originY”Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ObjectGeometry.getPointByOrigin
getRelativeCenterPoint()
Section titled “getRelativeCenterPoint()”getRelativeCenterPoint():
Point
Defined in: src/shapes/Object/ObjectGeometry.ts:746
Returns the center coordinates of the object relative to it’s parent
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ObjectGeometry.getRelativeCenterPoint
getRelativeX()
Section titled “getRelativeX()”getRelativeX():
number
Defined in: src/shapes/Object/ObjectGeometry.ts:115
Returns
Section titled “Returns”number
x position according to object’s FabricObject#originX property in parent’s coordinate plane
if parent is canvas then this property is identical to getX
Inherited from
Section titled “Inherited from”ObjectGeometry.getRelativeX
getRelativeXY()
Section titled “getRelativeXY()”getRelativeXY():
Point
Defined in: src/shapes/Object/ObjectGeometry.ts:176
Returns
Section titled “Returns”x,y position according to object’s FabricObject#originX FabricObject#originY properties in parent’s coordinate plane
Inherited from
Section titled “Inherited from”ObjectGeometry.getRelativeXY
getRelativeY()
Section titled “getRelativeY()”getRelativeY():
number
Defined in: src/shapes/Object/ObjectGeometry.ts:131
Returns
Section titled “Returns”number
y position according to object’s FabricObject#originY property in parent’s coordinate plane
if parent is canvas then this property is identical to getY
Inherited from
Section titled “Inherited from”ObjectGeometry.getRelativeY
getScaledHeight()
Section titled “getScaledHeight()”getScaledHeight():
number
Defined in: src/shapes/Object/ObjectGeometry.ts:363
Returns height of an object bounding box counting transformations
Returns
Section titled “Returns”number
height value
shouldn’t this account for group transform and return the actual size in canvas coordinate plane?
Inherited from
Section titled “Inherited from”ObjectGeometry.getScaledHeight
getScaledWidth()
Section titled “getScaledWidth()”getScaledWidth():
number
Defined in: src/shapes/Object/ObjectGeometry.ts:354
Returns width of an object’s bounding box counting transformations
Returns
Section titled “Returns”number
width value
shouldn’t this account for group transform and return the actual size in canvas coordinate plane?
Inherited from
Section titled “Inherited from”ObjectGeometry.getScaledWidth
getTotalAngle()
Section titled “getTotalAngle()”getTotalAngle():
TDegree
Defined in: src/shapes/Object/ObjectGeometry.ts:410
Returns the object angle relative to canvas counting also the group property
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ObjectGeometry.getTotalAngle
getTotalObjectScaling()
Section titled “getTotalObjectScaling()”getTotalObjectScaling():
Point
Defined in: src/shapes/Object/Object.ts:557
Return the object scale factor counting also the group scaling, zoom and retina
Returns
Section titled “Returns”object with scaleX and scaleY properties
getViewportTransform()
Section titled “getViewportTransform()”getViewportTransform():
TMat2D
Defined in: src/shapes/Object/ObjectGeometry.ts:420
Retrieves viewportTransform from Object’s canvas if available
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ObjectGeometry.getViewportTransform
getX()
Section titled “getX()”getX():
number
Defined in: src/shapes/Object/ObjectGeometry.ts:86
Returns
Section titled “Returns”number
x position according to object’s FabricObject#originX property in canvas coordinate plane
Inherited from
Section titled “Inherited from”ObjectGeometry.getX
getXY()
Section titled “getXY()”getXY():
Point
Defined in: src/shapes/Object/ObjectGeometry.ts:146
Returns
Section titled “Returns”x position according to object’s FabricObject#originX FabricObject#originY properties in canvas coordinate plane
Inherited from
Section titled “Inherited from”ObjectGeometry.getXY
getY()
Section titled “getY()”getY():
number
Defined in: src/shapes/Object/ObjectGeometry.ts:100
Returns
Section titled “Returns”number
y position according to object’s FabricObject#originY property in canvas coordinate plane
Inherited from
Section titled “Inherited from”ObjectGeometry.getY
hasCommonAncestors()
Section titled “hasCommonAncestors()”hasCommonAncestors<
T>(other):boolean
Defined in: src/shapes/Object/Object.ts:1710
Type Parameters
Section titled “Type Parameters”T extends FabricObject<Props, SProps, EventSpec>
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”boolean
hasFill()
Section titled “hasFill()”hasFill():
null|boolean|""
Defined in: src/shapes/Object/Object.ts:751
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
Section titled “Returns”null | boolean | ""
Boolean
3.0.0
hasStroke()
Section titled “hasStroke()”hasStroke():
null|boolean|""
Defined in: src/shapes/Object/Object.ts:735
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
Section titled “Returns”null | boolean | ""
Boolean
3.0.0
intersectsWithObject()
Section titled “intersectsWithObject()”intersectsWithObject(
other):boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:234
Checks if object intersects with another object
Parameters
Section titled “Parameters”ObjectGeometry
Object to test
Returns
Section titled “Returns”boolean
true if object intersects with another object
Inherited from
Section titled “Inherited from”ObjectGeometry.intersectsWithObject
intersectsWithRect()
Section titled “intersectsWithRect()”intersectsWithRect(
tl,br):boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:220
Checks if object intersects with the scene rect formed by TL and BR In this case the rect is meant aligned with the axis of the canvas. TL is the TOP LEFT point while br is the BOTTOM RIGHT point
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”ObjectGeometry.intersectsWithRect
isCacheDirty()
Section titled “isCacheDirty()”isCacheDirty(
skipCanvas):boolean
Defined in: src/shapes/Object/Object.ts:923
Check if cache is dirty and if is dirty clear the context. This check has a big side effect, it changes the underlying cache canvas if necessary. Do not call this method on your own to check if the cache is dirty, because if it is, it is also going to wipe the cache. This is badly designed and needs to be fixed.
Parameters
Section titled “Parameters”skipCanvas
Section titled “skipCanvas”boolean = false
skip canvas checks because this object is painted on parent canvas.
Returns
Section titled “Returns”boolean
isContainedWithinObject()
Section titled “isContainedWithinObject()”isContainedWithinObject(
other):boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:253
Checks if object is fully contained within area of another object
Parameters
Section titled “Parameters”ObjectGeometry
Object to test
Returns
Section titled “Returns”boolean
true if object is fully contained within area of another object
Inherited from
Section titled “Inherited from”ObjectGeometry.isContainedWithinObject
isContainedWithinRect()
Section titled “isContainedWithinRect()”isContainedWithinRect(
tl,br):boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:261
Checks if object is fully contained within the scene rect formed by TL and BR
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”ObjectGeometry.isContainedWithinRect
isDescendantOf()
Section titled “isDescendantOf()”isDescendantOf(
target):boolean
Defined in: src/shapes/Object/Object.ts:1614
Checks if object is descendant of target Should be used instead of Group.contains or StaticCanvas.contains for performance reasons
Parameters
Section titled “Parameters”target
Section titled “target”TAncestor
Returns
Section titled “Returns”boolean
isInFrontOf()
Section titled “isInFrontOf()”isInFrontOf<
T>(other):undefined|boolean
Defined in: src/shapes/Object/Object.ts:1720
Type Parameters
Section titled “Type Parameters”T extends FabricObject<Props, SProps, EventSpec>
Parameters
Section titled “Parameters”T
object to compare against
Returns
Section titled “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()
Section titled “isNotVisible()”isNotVisible():
boolean
Defined in: src/shapes/Object/Object.ts:650
Returns
Section titled “Returns”boolean
isOnScreen()
Section titled “isOnScreen()”isOnScreen():
boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:293
Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen
Returns
Section titled “Returns”boolean
true if object is fully or partially contained within canvas
Inherited from
Section titled “Inherited from”ObjectGeometry.isOnScreen
isOverlapping()
Section titled “isOverlapping()”isOverlapping<
T>(other):boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:271
Type Parameters
Section titled “Type Parameters”T extends ObjectGeometry<ObjectEvents>
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”ObjectGeometry.isOverlapping
isPartiallyOnScreen()
Section titled “isPartiallyOnScreen()”isPartiallyOnScreen():
boolean
Defined in: src/shapes/Object/ObjectGeometry.ts:323
Checks if object is partially contained within the canvas with current viewportTransform
Returns
Section titled “Returns”boolean
true if object is partially contained within canvas
Inherited from
Section titled “Inherited from”ObjectGeometry.isPartiallyOnScreen
isType()
Section titled “isType()”isType(…
types):boolean
Defined in: src/shapes/Object/Object.ts:1419
Returns true if any of the specified types is identical to the type of an instance
Parameters
Section titled “Parameters”…string[]
Returns
Section titled “Returns”boolean
needsItsOwnCache()
Section titled “needsItsOwnCache()”needsItsOwnCache():
boolean
Defined in: src/shapes/Object/Object.ts:763
When returns true, force the object to have its own cache, even if it is inside a group
it may be needed when your object behave in a particular way on the cache and always needs
its own isolated canvas to render correctly.
Created to be overridden
since 1.7.12
Returns
Section titled “Returns”boolean
Boolean
Call Signature
Section titled “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
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
event name (eg. ‘after:render’)
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.off
Call Signature
Section titled “Call Signature”off<
K>(eventName,handler):void
Defined in: src/Observable.ts:128
unsubscribe an event listener
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
event name (eg. ‘after:render’)
handler
Section titled “handler”TEventCallback
event listener to unsubscribe
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.off
Call Signature
Section titled “Call Signature”off(
handlers):void
Defined in: src/Observable.ts:133
unsubscribe event listeners
Parameters
Section titled “Parameters”handlers
Section titled “handlers”EventRegistryObject<EventSpec>
handlers key/value pairs (eg. {‘after:render’: handler, ‘selection:cleared’: handler})
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.off
Call Signature
Section titled “Call Signature”off():
void
Defined in: src/Observable.ts:137
unsubscribe all event listeners
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.off
Call Signature
Section titled “Call Signature”on<
K,E>(eventName,handler):VoidFunction
Defined in: src/Observable.ts:23
Observes specified event
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
E
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
Event name (eg. ‘after:render’)
handler
Section titled “handler”TEventCallback<E>
Function that receives a notification when an event of the specified type occurs
Returns
Section titled “Returns”VoidFunction
disposer
on
Inherited from
Section titled “Inherited from”ObjectGeometry.on
Call Signature
Section titled “Call Signature”on(
handlers):VoidFunction
Defined in: src/Observable.ts:27
Observes specified event
Parameters
Section titled “Parameters”handlers
Section titled “handlers”EventRegistryObject<EventSpec>
key/value pairs (eg. {‘after:render’: handler, ‘selection:cleared’: handler})
Returns
Section titled “Returns”VoidFunction
disposer
on
Inherited from
Section titled “Inherited from”ObjectGeometry.on
once()
Section titled “once()”Call Signature
Section titled “Call Signature”once<
K,E>(eventName,handler):VoidFunction
Defined in: src/Observable.ts:62
Observes specified event once
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
E
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
Event name (eg. ‘after:render’)
handler
Section titled “handler”TEventCallback<E>
Function that receives a notification when an event of the specified type occurs
Returns
Section titled “Returns”VoidFunction
disposer
once
Inherited from
Section titled “Inherited from”ObjectGeometry.once
Call Signature
Section titled “Call Signature”once(
handlers):VoidFunction
Defined in: src/Observable.ts:66
Observes specified event once
Parameters
Section titled “Parameters”handlers
Section titled “handlers”EventRegistryObject<EventSpec>
key/value pairs (eg. {‘after:render’: handler, ‘selection:cleared’: handler})
Returns
Section titled “Returns”VoidFunction
disposer
once
Inherited from
Section titled “Inherited from”ObjectGeometry.once
render()
Section titled “render()”render(
ctx):void
Defined in: src/shapes/Object/Object.ts:662
Renders an object on a specified context
Parameters
Section titled “Parameters”CanvasRenderingContext2D
Context to render on
Returns
Section titled “Returns”void
renderCache()
Section titled “renderCache()”renderCache(
this,options?):void
Defined in: src/shapes/Object/Object.ts:696
Parameters
Section titled “Parameters”TCachedFabricObject
options?
Section titled “options?”any
Returns
Section titled “Returns”void
rotate()
Section titled “rotate()”rotate(
angle):void
Defined in: src/shapes/Object/Object.ts:1447
Sets “angle” of an instance with centered rotation
Parameters
Section titled “Parameters”Angle value (in degrees)
Returns
Section titled “Returns”void
scale()
Section titled “scale()”scale(
value):void
Defined in: src/shapes/Object/ObjectGeometry.ts:372
Scales an object (equally by x and y)
Parameters
Section titled “Parameters”number
Scale factor
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.scale
scaleToHeight()
Section titled “scaleToHeight()”scaleToHeight(
value):void
Defined in: src/shapes/Object/ObjectGeometry.ts:395
Scales an object to a given height, with respect to bounding box (scaling by x/y equally)
Parameters
Section titled “Parameters”number
New height value
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.scaleToHeight
scaleToWidth()
Section titled “scaleToWidth()”scaleToWidth(
value):void
Defined in: src/shapes/Object/ObjectGeometry.ts:383
Scales an object to a given width, with respect to bounding box (scaling by x/y equally)
Parameters
Section titled “Parameters”number
New width value
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.scaleToWidth
set(
key,value?):FabricObject<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
Section titled “Parameters”Property name or object (if object, iterate over the object properties)
string | Record<string, any>
value?
Section titled “value?”any
Property value (if function, the value is passed into it and its return value is used as a new one)
Returns
Section titled “Returns”FabricObject<Props, SProps, EventSpec>
Inherited from
Section titled “Inherited from”ObjectGeometry.set
setCoords()
Section titled “setCoords()”setCoords():
void
Defined in: src/shapes/Object/ObjectGeometry.ts:451
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
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.setCoords
setOnGroup()
Section titled “setOnGroup()”setOnGroup():
void
Defined in: src/shapes/Object/Object.ts:1479
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
Section titled “Returns”void
setPositionByOrigin()
Section titled “setPositionByOrigin()”setPositionByOrigin(
pos,originX,originY):void
Defined in: src/shapes/Object/ObjectGeometry.ts:780
Sets the position of the object taking into consideration the object’s origin
Parameters
Section titled “Parameters”The new position of the object
originX
Section titled “originX”Horizontal origin: ‘left’, ‘center’ or ‘right’
originY
Section titled “originY”Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.setPositionByOrigin
setRelativeX()
Section titled “setRelativeX()”setRelativeX(
value):void
Defined in: src/shapes/Object/ObjectGeometry.ts:123
Parameters
Section titled “Parameters”number
x position according to object’s FabricObject#originX property in parent’s coordinate plane
if parent is canvas then this method is identical to setX
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.setRelativeX
setRelativeXY()
Section titled “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
Section titled “Parameters”position according to object’s FabricObject#originX FabricObject#originY properties in parent’s coordinate plane
originX?
Section titled “originX?”TOriginX = ...
Horizontal origin: ‘left’, ‘center’ or ‘right’
originY?
Section titled “originY?”TOriginY = ...
Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.setRelativeXY
setRelativeY()
Section titled “setRelativeY()”setRelativeY(
value):void
Defined in: src/shapes/Object/ObjectGeometry.ts:139
Parameters
Section titled “Parameters”number
y position according to object’s FabricObject#originY property in parent’s coordinate plane
if parent is canvas then this property is identical to setY
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.setRelativeY
setX()
Section titled “setX()”setX(
value):void
Defined in: src/shapes/Object/ObjectGeometry.ts:93
Parameters
Section titled “Parameters”number
x position according to object’s FabricObject#originX property in canvas coordinate plane
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.setX
setXY()
Section titled “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 FabricObject#originX and FabricObject#originY values, that otherwise are the object’s current values.
Parameters
Section titled “Parameters”position in scene coordinate plane
originX?
Section titled “originX?”Horizontal origin: ‘left’, ‘center’ or ‘right’
originY?
Section titled “originY?”Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Section titled “Returns”void
Example
Section titled “Example”object.setXY(new Point(5, 5), 'left', 'bottom').Inherited from
Section titled “Inherited from”ObjectGeometry.setXY
setY()
Section titled “setY()”setY(
value):void
Defined in: src/shapes/Object/ObjectGeometry.ts:107
Parameters
Section titled “Parameters”number
y position according to object’s FabricObject#originY property in canvas coordinate plane
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ObjectGeometry.setY
shouldCache()
Section titled “shouldCache()”shouldCache():
boolean
Defined in: src/shapes/Object/Object.ts:788
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. 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
Section titled “Returns”boolean
toBlob()
Section titled “toBlob()”toBlob(
options):Promise<null|Blob>
Defined in: src/shapes/Object/Object.ts:1406
Parameters
Section titled “Parameters”options
Section titled “options”toDataURLOptions = {}
Returns
Section titled “Returns”Promise<null | Blob>
toCanvasElement()
Section titled “toCanvasElement()”toCanvasElement(
options):HTMLCanvasElement
Defined in: src/shapes/Object/Object.ts:1303
Converts an object into a HTMLCanvas element
Parameters
Section titled “Parameters”options
Section titled “options”ObjectToCanvasElementOptions = {}
Options object
Returns
Section titled “Returns”HTMLCanvasElement
Returns DOM element
toDatalessObject()
Section titled “toDatalessObject()”toDatalessObject(
propertiesToInclude?):any
Defined in: src/shapes/Object/Object.ts:1854
Returns (dataless) object representation of an instance
Parameters
Section titled “Parameters”propertiesToInclude?
Section titled “propertiesToInclude?”any[]
Any properties that you might want to additionally include in the output
Returns
Section titled “Returns”any
Object representation of an instance
toDataURL()
Section titled “toDataURL()”toDataURL(
options):string
Defined in: src/shapes/Object/Object.ts:1399
Converts an object into a data-url-like string
Parameters
Section titled “Parameters”options
Section titled “options”toDataURLOptions = {}
Options object
Returns
Section titled “Returns”string
Returns a data: URL containing a representation of the object in the format specified by options.format
toggle()
Section titled “toggle()”toggle(
property):FabricObject<Props,SProps,EventSpec>
Defined in: src/CommonMethods.ts:46
Toggles specified property from true to false or from false to true
Parameters
Section titled “Parameters”property
Section titled “property”string
Property to toggle
Returns
Section titled “Returns”FabricObject<Props, SProps, EventSpec>
Inherited from
Section titled “Inherited from”ObjectGeometry.toggle
toJSON()
Section titled “toJSON()”toJSON():
any
Defined in: src/shapes/Object/Object.ts:1438
Returns a JSON representation of an instance
Returns
Section titled “Returns”any
JSON
toObject()
Section titled “toObject()”toObject(
propertiesToInclude?):any
Defined in: src/shapes/Object/Object.ts:1761
Returns an object representation of an instance
Parameters
Section titled “Parameters”propertiesToInclude?
Section titled “propertiesToInclude?”any[] = []
Any properties that you might want to additionally include in the output
Returns
Section titled “Returns”any
Object representation of an instance
toString()
Section titled “toString()”toString():
string
Defined in: src/shapes/Object/Object.ts:1894
Returns a string representation of an instance
Returns
Section titled “Returns”string
transform()
Section titled “transform()”transform(
ctx):void
Defined in: src/shapes/Object/Object.ts:528
Transforms context when rendering an object
Parameters
Section titled “Parameters”CanvasRenderingContext2D
Context
Returns
Section titled “Returns”void
transformMatrixKey()
Section titled “transformMatrixKey()”transformMatrixKey(
skipGroup):number[]
Defined in: src/shapes/Object/ObjectGeometry.ts:455
Parameters
Section titled “Parameters”skipGroup
Section titled “skipGroup”boolean = false
Returns
Section titled “Returns”number[]
Inherited from
Section titled “Inherited from”ObjectGeometry.transformMatrixKey
translateToCenterPoint()
Section titled “translateToCenterPoint()”translateToCenterPoint(
point,originX,originY):Point
Defined in: src/shapes/Object/ObjectGeometry.ts:685
Translates the coordinates from origin to center coordinates (based on the object’s dimensions)
Parameters
Section titled “Parameters”The point which corresponds to the originX and originY params
originX
Section titled “originX”Horizontal origin: ‘left’, ‘center’ or ‘right’
originY
Section titled “originY”Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ObjectGeometry.translateToCenterPoint
translateToGivenOrigin()
Section titled “translateToGivenOrigin()”translateToGivenOrigin(
point,fromOriginX,fromOriginY,toOriginX,toOriginY):Point
Defined in: src/shapes/Object/ObjectGeometry.ts:657
Translates the coordinates from a set of origin to another (based on the object’s dimensions)
Parameters
Section titled “Parameters”The point which corresponds to the originX and originY params
fromOriginX
Section titled “fromOriginX”Horizontal origin: ‘left’, ‘center’ or ‘right’
fromOriginY
Section titled “fromOriginY”Vertical origin: ‘top’, ‘center’ or ‘bottom’
toOriginX
Section titled “toOriginX”Horizontal origin: ‘left’, ‘center’ or ‘right’
toOriginY
Section titled “toOriginY”Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ObjectGeometry.translateToGivenOrigin
translateToOriginPoint()
Section titled “translateToOriginPoint()”translateToOriginPoint(
center,originX,originY):Point
Defined in: src/shapes/Object/ObjectGeometry.ts:713
Translates the coordinates from center to origin coordinates (based on the object’s dimensions)
Parameters
Section titled “Parameters”center
Section titled “center”The point which corresponds to center of the object
originX
Section titled “originX”Horizontal origin: ‘left’, ‘center’ or ‘right’
originY
Section titled “originY”Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ObjectGeometry.translateToOriginPoint
willDrawShadow()
Section titled “willDrawShadow()”willDrawShadow():
boolean
Defined in: src/shapes/Object/Object.ts:801
Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively
Returns
Section titled “Returns”boolean
_fromObject()
Section titled “_fromObject()”
static_fromObject<S>(__namedParameters,__namedParameters):Promise<S>
Defined in: src/shapes/Object/Object.ts:1907
Type Parameters
Section titled “Type Parameters”S extends FabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Record<string, unknown>
__namedParameters
Section titled “__namedParameters”Abortable & object = {}
Returns
Section titled “Returns”Promise<S>
fromObject()
Section titled “fromObject()”
staticfromObject<T>(object,options?):Promise<FabricObject<Partial<ObjectProps>,SerializedObjectProps,ObjectEvents>>
Defined in: src/shapes/Object/Object.ts:1936
Type Parameters
Section titled “Type Parameters”T extends TOptions<SerializedObjectProps>
Parameters
Section titled “Parameters”object
Section titled “object”T
options?
Section titled “options?”Returns
Section titled “Returns”Promise<FabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>>
getDefaults()
Section titled “getDefaults()”
staticgetDefaults():Record<string,any>
Defined in: src/shapes/Object/Object.ts:329
Returns
Section titled “Returns”Record<string, any>