FabricImage
Tutorial
http://fabricjs.com/fabric-intro-part-1#images
Extends
FabricObject<Props,SProps,EventSpec>
Type Parameters
• Props extends TOptions<ImageProps> = Partial<ImageProps>
• SProps extends SerializedImageProps = SerializedImageProps
• EventSpec extends ObjectEvents = ObjectEvents
Implements
Constructors
new FabricImage()
new FabricImage<
Props,SProps,EventSpec>(elementId,options?):FabricImage<Props,SProps,EventSpec>
Constructor Image can be initialized with any canvas drawable or a string. The string should be a url and will be loaded as an image. Canvas and Image element work out of the box, while videos require extra code to work. Please check video element events for seeking.
Parameters
• elementId: string
• options?: Props
Options object
Returns
FabricImage<Props, SProps, EventSpec>
Overrides
Defined in
new FabricImage()
new FabricImage<
Props,SProps,EventSpec>(element,options?):FabricImage<Props,SProps,EventSpec>
Parameters
• element: ImageSource
• options?: Props
Returns
FabricImage<Props, SProps, EventSpec>
Overrides
FabricObject<Props, SProps, EventSpec>.constructor
Defined in
Properties
__corner?
optional__corner:string
keeps the value of the last hovered corner during mouse move. 0 is no corner, or ‘mt’, ‘ml’, ‘mtr’ etc.. It should be private, but there is no harm in using it as a read-only property. this isn’t cleaned automatically. Non selected objects may have wrong values
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:105
_controlsVisibility
_controlsVisibility:
Record<string,boolean>
a map of control visibility for this object. this was left when controls were introduced to not break the api too much this takes priority over the generic control visibility
Inherited from
FabricObject._controlsVisibility
Defined in
src/shapes/Object/InteractiveObject.ts:112
_element
_element:
ImageSource
Defined in
_filteredEl?
optional_filteredEl:HTMLCanvasElement
Defined in
_originalElement
_originalElement:
ImageSource
Defined in
_scaling?
optional_scaling:boolean
A boolean used from the gesture module to keep tracking of a scaling action when there is no scaling transform in place. This is an edge case and is used twice in all codebase. Probably added to keep track of some performance issues
TODO
use git blame to investigate why it was added DON’T USE IT. WE WILL TRY TO REMOVE IT
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:134
aCoords
aCoords:
TCornerPoint
Describe object’s corner position in scene coordinates. The coordinates are derived from the following: left, top, width, height, scaleX, scaleY, skewX, skewY, angle, strokeWidth. The coordinates do not depend on viewport changes. The coordinates get updated with setCoords. You can calculate them without updating with ()
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:63
absolutePositioned
absolutePositioned:
boolean
Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will not be influenced by the object transform. This will make the clipPath relative to the canvas, but clipping just a particular object. WARNING this is beta, this feature may change or be renamed. since 2.4.0
Default
falseImplementation of
Inherited from
FabricObject.absolutePositioned
Defined in
src/shapes/Object/Object.ts:218
angle
angle:
TDegree
Angle of rotation of an object (in degrees)
Default
0Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:581
backgroundColor
backgroundColor:
string
Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:205
borderColor
borderColor:
string
Color of controlling borders of an object (when it’s active)
Default
rgb(178,204,255)Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:74
borderDashArray
borderDashArray:
null|number[]
Array specifying dash pattern of an object’s borders (hasBorder must be true)
Since
1.6.2
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:75
borderOpacityWhenMoving
borderOpacityWhenMoving:
number
Opacity of object’s controlling borders when object is active and moving
Default
0.4Implementation of
ImageProps.borderOpacityWhenMoving
Inherited from
FabricObject.borderOpacityWhenMoving
Defined in
src/shapes/Object/InteractiveObject.ts:76
borderScaleFactor
borderScaleFactor:
number
Scale factor of object’s controlling borders bigger number will make a thicker border border is 1, so this is basically a border thickness since there is no way to change the border itself.
Default
1Implementation of
Inherited from
FabricObject.borderScaleFactor
Defined in
src/shapes/Object/InteractiveObject.ts:77
cacheKey
cacheKey:
string
key used to retrieve the texture representing this image
Since
2.0.0
Default
Defined in
centeredRotation
centeredRotation:
boolean
When true the object will rotate on its center.
When false will rotate around the origin point defined by originX and originY.
The value of this property is IGNORED during a transform if the canvas has already
centeredRotation set to true
The object method rotate will always consider this property and never the canvas’s one.
Since
1.3.4
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:219
centeredScaling
centeredScaling:
boolean
When true, this object will use center point as the origin of transformation when being scaled via the controls.
Since
1.3.4
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:220
clipPath?
optionalclipPath:BaseFabricObject<Partial<ObjectProps>,SerializedObjectProps,ObjectEvents>
a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center of the object cacheCanvas. If you want 0,0 of a clipPath to align with an object center, use clipPath.originX/Y to ‘center’
Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:216
clipPathId?
optionalclipPathId:string
When an object is being exported as SVG as a clippath, a reference inside the SVG is needed. This reference is a UID in the fabric namespace and is temporary stored here.
Inherited from
Defined in
src/shapes/Object/FabricObjectSVGExportMixin.ts:14
controls
controls:
TControlSet
holds the controls for the object. controls are added by default_controls.js
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:118
cornerColor
cornerColor:
string
Color of controlling corners of an object (when it’s active)
Default
rgb(178,204,255)Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:68
cornerDashArray
cornerDashArray:
null|number[]
Array specifying dash pattern of an object’s control (hasBorder must be true)
Since
1.6.2
Default
nullImplementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:71
cornerSize
cornerSize:
number
Size of object’s controlling corners (in pixels)
Default
13Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:65
cornerStrokeColor
cornerStrokeColor:
string
Color of controlling corners of an object (when it’s active and transparentCorners false)
Since
1.6.2
Default
''Implementation of
Inherited from
FabricObject.cornerStrokeColor
Defined in
src/shapes/Object/InteractiveObject.ts:69
cornerStyle
cornerStyle:
"circle"|"rect"
Specify style of control, ‘rect’ or ‘circle’ This is deprecated. In the future there will be a standard control render And you can swap it with one of the alternative proposed with the control api
Since
1.6.2
Default
'rect'Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:70
cropX
cropX:
number
Image crop in pixels from original image size.
Since
2.0.0
Default
Implementation of
Defined in
cropY
cropY:
number
Image crop in pixels from original image size.
Since
2.0.0
Default
Implementation of
Defined in
dirty
dirty:
boolean
When set to true, object’s cache will be rerendered next render call.
since 1.7.0
Default
trueInherited from
Defined in
src/shapes/Object/Object.ts:245
evented
evented:
boolean
When set to false, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:82
excludeFromExport
excludeFromExport:
boolean
When true, object is not exported in OBJECT/JSON
Since
1.6.3
Default
Implementation of
Inherited from
FabricObject.excludeFromExport
Defined in
src/shapes/Object/Object.ts:212
fill
fill:
null|string|TFiller
Color of object’s fill takes css colors https://www.w3.org/TR/css-color-3/
Default
rgb(0,0,0)Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:195
fillRule
fillRule:
CanvasFillRule
Fill rule used to fill an object
accepted values are nonzero, evenodd
Backwards incompatibility note: This property was used for setting globalCompositeOperation until v1.4.12 (use globalCompositeOperation instead)
Default
nonzeroImplementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:196
filters
filters:
BaseFilter<string,Record<string,any>>[]
Implementation of
Defined in
flipX
flipX:
boolean
When true, an object is rendered as flipped horizontally
Default
falseImplementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:567
flipY
flipY:
boolean
When true, an object is rendered as flipped vertically
Default
falseImplementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:568
globalCompositeOperation
globalCompositeOperation:
GlobalCompositeOperation
Composite rule used for canvas globalCompositeOperation
Default
Implementation of
ImageProps.globalCompositeOperation
Inherited from
FabricObject.globalCompositeOperation
Defined in
src/shapes/Object/Object.ts:204
hasBorders
hasBorders:
boolean
When set to false, object’s controlling borders are not rendered
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:78
hasControls
hasControls:
boolean
When set to false, object’s controls are not displayed and can not be used to manipulate object
Default
trueImplementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:72
height
height:
number
Object height
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:566
hoverCursor
hoverCursor:
null|string
Default cursor value used when hovering over this object on canvas
Default
nullImplementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:86
imageSmoothing
imageSmoothing:
boolean
Indicates whether this canvas will use image smoothing when painting this image. Also influence if the cacheCanvas for this image uses imageSmoothing
Since
4.0.0-beta.11
Default
Implementation of
Defined in
includeDefaultValues
includeDefaultValues:
boolean
When false, default object’s values are not included in its serialization
Default
Implementation of
ImageProps.includeDefaultValues
Inherited from
FabricObject.includeDefaultValues
Defined in
src/shapes/Object/Object.ts:211
inverted
inverted:
boolean
Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath since 2.4.0
Default
falseImplementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:217
isMoving?
optionalisMoving:boolean
internal boolean to signal the code that the object is part of the move action.
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:124
left
left:
number
Left position of an object. Note that by default it’s relative to object left. You can change this by setting originX
Default
0Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:564
lockMovementX
lockMovementX:
boolean
When true, object horizontal movement is locked
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:56
lockMovementY
lockMovementY:
boolean
When true, object vertical movement is locked
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:57
lockRotation
lockRotation:
boolean
When true, object rotation is locked
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:58
lockScalingFlip
lockScalingFlip:
boolean
When true, object cannot be flipped by scaling into negative values
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:63
lockScalingX
lockScalingX:
boolean
When true, object horizontal scaling is locked
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:59
lockScalingY
lockScalingY:
boolean
When true, object vertical scaling is locked
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:60
lockSkewingX
lockSkewingX:
boolean
When true, object horizontal skewing is locked
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:61
lockSkewingY
lockSkewingY:
boolean
When true, object vertical skewing is locked
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:62
matrixCache?
optionalmatrixCache:TMatrixCache
storage cache for object full transform matrix
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:73
minScaleLimit
minScaleLimit:
number
Minimum allowed scale value of an object
Default
0Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:190
minimumScaleTrigger
minimumScaleTrigger:
number
minimum scale factor under which any resizeFilter is triggered to resize the image 0 will disable the automatic resize. 1 will trigger automatically always. number bigger than 1 are not implemented yet.
Implementation of
ImageProps.minimumScaleTrigger
Defined in
moveCursor
moveCursor:
null|string
Default cursor value used when moving this object on canvas
Default
nullImplementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:87
noScaleCache
noScaleCache:
boolean
When true, cache does not get updated during scaling. The picture will get blocky if scaled
too much and will be redrawn with correct details at the end of scaling.
this setting is performance and application dependant.
default to true
since 1.7.0
Default
trueImplementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:51
oCoords
oCoords:
Record<string,TOCoord>
The object’s controls’ position in viewport coordinates
Calculated by Control#positionHandler and Control#calcCornerCoords, depending on padding.
corner/touchCorner describe the 4 points forming the interactive area of the corner.
Used to draw and locate controls.
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:95
objectCaching
objectCaching:
boolean
When true, object is cached on an additional canvas.
When false, object is not cached unless necessary ( clipPath )
default to true
Since
1.7.0
Default
trueImplementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:214
opacity
opacity:
number
Opacity of an object
Default
1Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:192
originX
originX:
TOriginX
Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:576
originY
originY:
TOriginY
Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:580
ownMatrixCache?
optionalownMatrixCache:TMatrixCache
storage cache for object transform matrix
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:68
padding
padding:
number
Padding between object and its controlling borders (in pixels)
Default
0Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:53
paintFirst
paintFirst:
"fill"|"stroke"
Determines if the fill or the stroke is drawn first (one of “fill” or “stroke”)
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:194
parent?
optionalparent:Group
A reference to the parent of the object
Used to keep the original parent ref when the object has been added to an ActiveSelection, hence loosing the group ref
Inherited from
Defined in
src/shapes/Object/Object.ts:1636
perPixelTargetFind
perPixelTargetFind:
boolean
When set to true, objects are “found” on canvas on per-pixel basis rather than according to bounding box
Default
Implementation of
Inherited from
FabricObject.perPixelTargetFind
Defined in
src/shapes/Object/InteractiveObject.ts:83
preserveAspectRatio
preserveAspectRatio:
string
Defined in
resizeFilter
resizeFilter:
Resize
Implementation of
Defined in
scaleX
scaleX:
number
Object scale factor (horizontal)
Default
1Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:569
scaleY
scaleY:
number
Object scale factor (vertical)
Default
1Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:570
selectable
selectable:
boolean
When set to false, an object can not be selected for modification (using either point-click-based or group-based selection).
But events still fire on it.
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:81
selectionBackgroundColor
selectionBackgroundColor:
string
Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods.
Default
Implementation of
ImageProps.selectionBackgroundColor
Inherited from
FabricObject.selectionBackgroundColor
Defined in
src/shapes/Object/InteractiveObject.ts:79
shadow
shadow:
null|Shadow
Shadow object representing shadow of this shape
Default
nullImplementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:207
skewX
skewX:
number
Angle of skew on x axes of an object (in degrees)
Default
0Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:571
skewY
skewY:
number
Angle of skew on y axes of an object (in degrees)
Default
0Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:572
snapAngle?
optionalsnapAngle:TDegree
The angle that an object will lock to while rotating.
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:53
snapThreshold?
optionalsnapThreshold:TDegree
The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle.
Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:54
srcFromAttribute
srcFromAttribute:
boolean
When calling FabricImage.getSrc, return value from element src with element.getAttribute('src').
This allows for relative urls as image src.
Since
2.7.0
Default
falseImplementation of
Defined in
stroke
stroke:
null|string|TFiller
When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/
Default
nullImplementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:197
strokeDashArray
strokeDashArray:
null|number[]
Array specifying dash pattern of an object’s stroke (stroke must be defined)
Default
null;Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:198
strokeDashOffset
strokeDashOffset:
number
Line offset of an object’s stroke
Default
0Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:199
strokeLineCap
strokeLineCap:
CanvasLineCap
Line endings style of an object’s stroke (one of “butt”, “round”, “square”)
Default
buttImplementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:200
strokeLineJoin
strokeLineJoin:
CanvasLineJoin
Corner style of an object’s stroke (one of “bevel”, “round”, “miter”)
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:201
strokeMiterLimit
strokeMiterLimit:
number
Maximum miter length (used for strokeLineJoin = “miter”) of an object’s stroke
Default
4Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:202
strokeUniform
strokeUniform:
boolean
When false, the stoke width will scale with the object.
When true, the stroke will always match the exact pixel size entered for stroke width.
this Property does not work on Text classes or drawing call that uses strokeText,fillText methods
default to false
Since
2.6.0
Default
falseDefault
falseImplementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:583
strokeWidth
strokeWidth:
number
Width of a stroke used to render this object
Default
1Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:582
top
top:
number
Top position of an object. Note that by default it’s relative to object top. You can change this by setting originY
Default
0Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:563
touchCornerSize
touchCornerSize:
number
Size of object’s controlling corners when touch interaction is detected
Default
24Implementation of
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:66
transparentCorners
transparentCorners:
boolean
When true, object’s controlling corners are rendered as transparent inside (i.e. stroke instead of fill)
Default
trueImplementation of
Inherited from
FabricObject.transparentCorners
Defined in
src/shapes/Object/InteractiveObject.ts:67
visible
visible:
boolean
When set to false, an object is not rendered on canvas
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/Object.ts:209
width
width:
number
Object width
Default
Implementation of
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:565
ATTRIBUTE_NAMES
staticATTRIBUTE_NAMES:string[]
List of attribute names to account for when parsing SVG element (used by FabricImage.fromElement)
Static
See
http://www.w3.org/TR/SVG/struct.html#ImageElement
Defined in
CSS_CANVAS
staticCSS_CANVAS:string='canvas-img'
Default CSS class name for canvas
Static
Default
Defined in
cacheProperties
staticcacheProperties:string[]
List of properties to consider when checking if cache needs refresh Those properties are checked by calls to Object.set(key, value). If the key is in this list, the object is marked as dirty and refreshed at the next render
Overrides
Defined in
colorProperties
staticcolorProperties:string[]
List of properties to consider for animating colors.
Inherited from
Defined in
src/shapes/Object/Object.ts:1543
customProperties
staticcustomProperties:string[] =[]
Define a list of custom properties that will be serialized when instance.toObject() gets called
Inherited from
Defined in
src/shapes/Object/Object.ts:1784
ownDefaults
staticownDefaults:Partial<TClassProperties<FabricImage<Partial<ImageProps>,SerializedImageProps,ObjectEvents>>> =imageDefaultValues
Overrides
Defined in
stateProperties
staticstateProperties:string[]
This list of properties is used to check if the state of an object is changed. This state change now is only used for children of groups to understand if a group needs its cache regenerated during a .set call
Inherited from
Defined in
src/shapes/Object/Object.ts:228
type
statictype:string='Image'
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.
Overrides
Defined in
Accessors
type
gettype():string
Legacy identifier of the class. Prefer using utils like isType or instanceOf Will be removed in fabric 7 or 8. The setter exists to avoid type errors in old code and possibly current deserialization code. DO NOT build new code around this type value
TODO
add sustainable warning message
settype(value):void
Parameters
• value: string
Returns
string
Inherited from
Defined in
src/shapes/Object/Object.ts:357
Methods
_drawClipPath()
_drawClipPath(
ctx,clipPath,context):void
Prepare clipPath state and cache and draw it on instance’s cache
Parameters
• ctx: CanvasRenderingContext2D
• clipPath: undefined | BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>
• context: DrawContext
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:920
_limitCacheSize()
_limitCacheSize(
dims):any
Limit the cache dimensions so that X * Y do not cross config.perfLimitSizeTotal and each side do not cross fabric.cacheSideLimit those numbers are configurable so that you can get as much detail as you want making bargain with performances.
Parameters
• dims: any
Returns
any
.width width of canvas
.height height of canvas
.zoomX zoomX zoom value to unscale the canvas before drawing cache
.zoomY zoomY zoom value to unscale the canvas before drawing cache
Inherited from
Defined in
src/shapes/Object/Object.ts:406
_removeCacheCanvas()
_removeCacheCanvas():
void
Remove cacheCanvas and its dimensions from the objects
Returns
void
Inherited from
FabricObject._removeCacheCanvas
Defined in
src/shapes/Object/Object.ts:756
_renderControls()
_renderControls(
ctx,styleOverride?):void
Renders controls and borders for the object the context here is not transformed
Parameters
• ctx: CanvasRenderingContext2D
Context to render on
• styleOverride?: TStyleOverride = {}
properties to override the object style
Returns
void
Todo
move to interactivity
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:435
_setClippingProperties()
_setClippingProperties(
ctx):void
Parameters
• ctx: CanvasRenderingContext2D
Returns
void
Inherited from
FabricObject._setClippingProperties
Defined in
src/shapes/Object/Object.ts:1062
_setFillStyles()
_setFillStyles(
ctx,__namedParameters):void
Parameters
• ctx: CanvasRenderingContext2D
• __namedParameters: Pick<FabricImage<Props, SProps, EventSpec>, "fill">
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:1051
_setStrokeStyles()
_setStrokeStyles(
ctx,decl):void
Parameters
• ctx: CanvasRenderingContext2D
• decl: Pick<FabricImage<Props, SProps, EventSpec>, "stroke" | "strokeDashOffset" | "strokeLineCap" | "strokeLineJoin" | "strokeMiterLimit" | "strokeWidth">
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:1009
_setupCompositeOperation()
_setupCompositeOperation(
ctx):void
Sets canvas globalCompositeOperation for specific object custom composition operation for the particular object can be specified using globalCompositeOperation property
Parameters
• ctx: CanvasRenderingContext2D
Rendering canvas context
Returns
void
Inherited from
FabricObject._setupCompositeOperation
Defined in
src/shapes/Object/Object.ts:1518
_toSVG()
_toSVG():
string[]
Returns svg representation of an instance
Returns
string[]
an array of strings with the specific svg representation of the instance
Overrides
Defined in
addPaintOrder()
addPaintOrder(
this):string
Parameters
• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>
Returns
string
Inherited from
Defined in
src/shapes/Object/FabricObjectSVGExportMixin.ts:249
animate()
animate<
T>(animatable,options?):Record<string,TAnimation<T>>
Animates object’s properties
Type Parameters
• T extends number | number[] | TColorArg
Parameters
• animatable: Record<string, T>
map of keys and end values
• options?: Partial<AnimationOptions<T>>
Returns
Record<string, TAnimation<T>>
map of animation contexts
As object — multiple properties
object.animate({ left: …, top: … }); object.animate({ left: …, top: … }, { duration: … });
Tutorial
http://fabricjs.com/fabric-intro-part-2#animation
Inherited from
Defined in
src/shapes/Object/Object.ts:1557
applyFilters()
applyFilters(
filters):void
Applies filters assigned to this image (from “filters” array) or from filter param
Parameters
• filters: BaseFilter<string, Record<string, any>>[] = ...
to be applied
Returns
void
Method
applyFilters
Defined in
applyResizeFilters()
applyResizeFilters():
void
Returns
void
Defined in
calcACoords()
calcACoords():
TCornerPoint
Calculates the coordinates of the 4 corner of the bbox, in absolute coordinates. those never change with zoom or viewport changes.
Returns
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:427
calcOCoords()
calcOCoords():
Record<string,TOCoord>
Calculates the coordinates of the center of each control plus the corners of the control itself This basically just delegates to each control positionHandler WARNING: changing what is passed to positionHandler is a breaking change, since position handler is a public api and should be done just if extremely necessary
Returns
Record<string, TOCoord>
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:255
calcOwnMatrix()
calcOwnMatrix():
TMat2D
calculate transform matrix that represents the current transformations from the object’s properties, this matrix does not include the group transformation
Returns
transform matrix for the object
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:513
calcTransformMatrix()
calcTransformMatrix(
skipGroup?):TMat2D
calculate transform matrix that represents the current transformations from the object’s properties.
Parameters
• skipGroup?: boolean = false
return transform matrix for object not counting parent transformations There are some situation in which this is useful to avoid the fake rotation.
Returns
transform matrix for the object
Inherited from
FabricObject.calcTransformMatrix
Defined in
src/shapes/Object/ObjectGeometry.ts:485
canDrop()
canDrop(
_e):boolean
Override to customize drag and drop behavior
Parameters
• _e: DragEvent
Returns
boolean
true if the object currently dragged can be dropped on the target
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:701
clearContextTop()
clearContextTop(
restoreManually?):undefined|CanvasRenderingContext2D
Clears the canvas.contextTop in a specific area that corresponds to the object’s bounding box that is in the canvas.contextContainer. This function is used to clear pieces of contextTop where we render ephemeral effects on top of the object. Example: blinking cursor text selection, drag effects.
Parameters
• restoreManually?: boolean
When true won’t restore the context after clear, in order to draw something else.
Returns
undefined | CanvasRenderingContext2D
canvas.contextTop that is either still transformed with the object transformMatrix, or restored to neutral transform
Todo
discuss swapping restoreManually with a renderCallback, but think of async issues
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:627
clone()
clone(
propertiesToInclude?):Promise<FabricImage<Props,SProps,EventSpec>>
Clones an instance.
Parameters
• propertiesToInclude?: string[]
Any properties that you might want to additionally include in the output
Returns
Promise<FabricImage<Props, SProps, EventSpec>>
Inherited from
Defined in
src/shapes/Object/Object.ts:1292
cloneAsImage()
cloneAsImage(
options?):FabricImage<Partial<ImageProps>,SerializedImageProps,ObjectEvents>
Creates an instance of Image out of an object makes use of toCanvasElement. Once this method was based on toDataUrl and loadImage, so it also had a quality and format option. toCanvasElement is faster and produce no loss of quality. If you need to get a real Jpeg or Png from an object, using toDataURL is the right way to do it. toCanvasElement and then toBlob from the obtained canvas is also a good option.
Parameters
• options?: ObjectToCanvasElementOptions
for clone as image, passed to toDataURL
Returns
FabricImage<Partial<ImageProps>, SerializedImageProps, ObjectEvents>
Object cloned as image.
Todo
fix the export type, it could not be Image but the type that getClass return for ‘image’.
Inherited from
Defined in
src/shapes/Object/Object.ts:1318
complexity()
complexity():
number
Returns complexity of an instance
Returns
number
complexity of this instance (is 1 unless subclassed)
Inherited from
Defined in
src/shapes/Object/Object.ts:1460
containsPoint()
containsPoint(
point):boolean
Checks if point is inside the object
Parameters
• point: Point
Point to check against
Returns
boolean
true if point is inside the object
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:282
dispose()
dispose():
void
Delete textures, reference to elements and eventually JSDOM cleanup
Returns
void
Overrides
Defined in
drawBorders()
drawBorders(
ctx,options,styleOverride?):void
Draws borders of an object’s bounding box. Requires public properties: width, height Requires public options: padding, borderColor
Parameters
• ctx: CanvasRenderingContext2D
Context to draw on
• options: Required<Omit<TComposeMatrixArgs, "flipX" | "flipY">>
object representing current object parameters
• styleOverride?: TStyleOverride
object to override the object style
Returns
void
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:478
drawCacheOnCanvas()
drawCacheOnCanvas(
this,ctx):void
Paint the cached copy of the object on the target context. it will set the imageSmoothing for the draw operation
Parameters
• this: TCachedFabricObject<FabricImage<Partial<ImageProps>, SerializedImageProps, ObjectEvents>>
• ctx: CanvasRenderingContext2D
Context to render on
Returns
void
Overrides
FabricObject.drawCacheOnCanvas
Defined in
drawClipPathOnCache()
drawClipPathOnCache(
ctx,clipPath,canvasWithClipPath):void
Execute the drawing operation for an object clipPath
Parameters
• ctx: CanvasRenderingContext2D
Context to render on
• clipPath: BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>
• canvasWithClipPath: HTMLCanvasElement
Returns
void
Inherited from
FabricObject.drawClipPathOnCache
Defined in
src/shapes/Object/Object.ts:847
drawControls()
drawControls(
ctx,styleOverride):void
Draws corners of an object’s bounding box. Requires public properties: width, height Requires public options: cornerSize, padding Be aware that since fabric 6.0 this function does not call setCoords anymore. setCoords needs to be called manually if the object of which we are rendering controls is outside the standard selection and transform process.
Parameters
• ctx: CanvasRenderingContext2D
Context to draw on
• styleOverride: Partial<Pick<InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>, "cornerStyle" | "cornerSize" | "cornerColor" | "cornerStrokeColor" | "cornerDashArray" | "transparentCorners">> = {}
object to override the object style
Returns
void
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:550
drawControlsConnectingLines()
drawControlsConnectingLines(
ctx,size):void
Draws lines from a borders of an object’s bounding box to controls that have withConnection property set.
Requires public properties: width, height
Requires public options: padding, borderColor
Parameters
• ctx: CanvasRenderingContext2D
Context to draw on
• size: Point
object size x = width, y = height
Returns
void
Inherited from
FabricObject.drawControlsConnectingLines
Defined in
src/shapes/Object/InteractiveObject.ts:517
drawObject()
drawObject(
ctx,forClipping,context):void
Execute the drawing operation for an object on a specified context
Parameters
• ctx: CanvasRenderingContext2D
Context to render on
• forClipping: undefined | boolean
apply clipping styles
• context: DrawContext
additional context for rendering
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:872
drawSelectionBackground()
drawSelectionBackground(
ctx):void
Draws a colored layer behind the object, inside its selection borders. Requires public options: padding, selectionBackgroundColor this function is called when the context is transformed has checks to be skipped when the object is on a staticCanvas
Parameters
• ctx: CanvasRenderingContext2D
Context to draw on
Returns
void
Todo
evaluate if make this disappear in favor of a pre-render hook for objects this was added by Andrea Bogazzi to make possible some feature for work reasons it seemed a good option, now is an edge case
Inherited from
FabricObject.drawSelectionBackground
Defined in
src/shapes/Object/InteractiveObject.ts:375
findCommonAncestors()
findCommonAncestors<
T>(other):AncestryComparison
Compare ancestors
Type Parameters
• T extends FabricImage<Props, SProps, EventSpec>
Parameters
• other: T
Returns
AncestryComparison
an object that represent the ancestry situation.
Inherited from
FabricObject.findCommonAncestors
Defined in
src/shapes/Object/Object.ts:1675
fire()
fire<
K>(eventName,options?):void
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
Defined in
forEachControl()
forEachControl(
fn):void
Calls a function for each control. The function gets called, with the control, the control’s key and the object that is calling the iterator
Parameters
• fn
function to iterate over the controls over
Returns
void
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:353
get()
get(
property):any
Basic getter
Parameters
• property: string
Property name
Returns
any
value of a property
Inherited from
Defined in
getActiveControl()
getActiveControl():
undefined|object
Returns
undefined | object
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:194
getAncestors()
getAncestors():
Ancestors
Returns
Ancestors
ancestors (excluding ActiveSelection) from bottom to top
Inherited from
Defined in
src/shapes/Object/Object.ts:1658
getBoundingRect()
getBoundingRect():
TBBox
Returns coordinates of object’s bounding rectangle (left, top, width, height) the box is intended as aligned to axis of canvas.
Returns
Object with left, top, width, height properties
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:343
getCanvasRetinaScaling()
getCanvasRetinaScaling():
number
Returns
number
Inherited from
FabricObject.getCanvasRetinaScaling
Defined in
src/shapes/Object/ObjectGeometry.ts:400
getCenterPoint()
getCenterPoint():
Point
Returns the center coordinates of the object relative to canvas
Returns
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:732
getCoords()
getCoords():
Point[]
Returns
Point[]
[tl, tr, br, bl] in the scene plane
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:204
getCrossOrigin()
getCrossOrigin():
null|string
Get the crossOrigin value (of the corresponding image element)
Returns
null | string
Defined in
getElement()
getElement():
ImageSource
Returns image element which this instance if based on
Returns
Defined in
getObjectOpacity()
getObjectOpacity():
number
Return the object opacity counting also the group property
Returns
number
Inherited from
Defined in
src/shapes/Object/Object.ts:607
getObjectScaling()
getObjectScaling():
Point
Return the object scale factor counting also the group scaling
Returns
Inherited from
Defined in
src/shapes/Object/Object.ts:576
getOriginalSize()
getOriginalSize():
object
Returns original size of an image
Returns
object
height
height:
any
width
width:
any
Defined in
getPointByOrigin()
getPointByOrigin(
originX,originY):Point
Returns the position of the object as if it has a different origin. Take an object that has left, top set to 100, 100 with origin ‘left’, ‘top’. Return the values of left top ( wrapped in a point ) that you would need to keep the same position if origin where different. Alternatively you can use this to also find which point in the parent plane is a specific origin ( where is the bottom right corner of my object? )
Parameters
• originX: TOriginX
Horizontal origin: ‘left’, ‘center’ or ‘right’
• originY: TOriginY
Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:762
getRelativeCenterPoint()
getRelativeCenterPoint():
Point
Returns the center coordinates of the object relative to it’s parent
Returns
Inherited from
FabricObject.getRelativeCenterPoint
Defined in
src/shapes/Object/ObjectGeometry.ts:743
getRelativeX()
getRelativeX():
number
Returns
number
x position according to object’s originX property in parent’s coordinate plane
if parent is canvas then this property is identical to getX
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:115
getRelativeXY()
getRelativeXY():
Point
Returns
x,y position according to object’s originX originY properties in parent’s coordinate plane
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:176
getRelativeY()
getRelativeY():
number
Returns
number
y position according to object’s originY property in parent’s coordinate plane
if parent is canvas then this property is identical to getY
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:131
getScaledHeight()
getScaledHeight():
number
Returns height of an object bounding box counting transformations
Returns
number
height value
Todo
shouldn’t this account for group transform and return the actual size in canvas coordinate plane?
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:361
getScaledWidth()
getScaledWidth():
number
Returns width of an object’s bounding box counting transformations
Returns
number
width value
Todo
shouldn’t this account for group transform and return the actual size in canvas coordinate plane?
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:352
getSrc()
getSrc(
filtered?):string
Returns source of an image
Parameters
• filtered?: boolean
indicates if the src is needed for svg
Returns
string
Source of an image
Defined in
getSvgCommons()
getSvgCommons(
this):string
Returns id attribute for svg output
Parameters
• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents> & object
Returns
string
Inherited from
Defined in
src/shapes/Object/FabricObjectSVGExportMixin.ts:84
getSvgFilter()
getSvgFilter(
this):string
Returns filter for svg shadow
Parameters
• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>
Returns
string
Inherited from
Defined in
src/shapes/Object/FabricObjectSVGExportMixin.ts:76
getSvgSrc()
getSvgSrc(
filtered?):string
Alias for getSrc
Parameters
• filtered?: boolean
Returns
string
Defined in
getSvgStyles()
getSvgStyles(
this,skipShadow?):string
Returns styles-string for svg-export
Parameters
• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>
• skipShadow?: boolean
a boolean to skip shadow filter output
Returns
string
Inherited from
Defined in
src/shapes/Object/FabricObjectSVGExportMixin.ts:21
getSvgTransform()
getSvgTransform(
this,full?,additionalTransform?):string
Returns transform-string for svg-export
Parameters
• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>
• full?: boolean
• additionalTransform?: string = ''
Returns
string
Inherited from
Defined in
src/shapes/Object/FabricObjectSVGExportMixin.ts:103
getTotalAngle()
getTotalAngle():
TDegree
Returns the object angle relative to canvas counting also the group property
Returns
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:408
getTotalObjectScaling()
getTotalObjectScaling():
Point
Return the object scale factor counting also the group scaling, zoom and retina
Returns
object with scaleX and scaleY properties
Inherited from
FabricObject.getTotalObjectScaling
Defined in
src/shapes/Object/Object.ts:593
getViewportTransform()
getViewportTransform():
TMat2D
Retrieves viewportTransform from Object’s canvas if available
Returns
Inherited from
FabricObject.getViewportTransform
Defined in
src/shapes/Object/ObjectGeometry.ts:418
getX()
getX():
number
Returns
number
x position according to object’s originX property in canvas coordinate plane
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:86
getXY()
getXY():
Point
Returns
x position according to object’s originX originY properties in canvas coordinate plane
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:146
getY()
getY():
number
Returns
number
y position according to object’s originY property in canvas coordinate plane
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:100
hasCommonAncestors()
hasCommonAncestors<
T>(other):boolean
Type Parameters
• T extends FabricImage<Props, SProps, EventSpec>
Parameters
• other: T
Returns
boolean
Inherited from
FabricObject.hasCommonAncestors
Defined in
src/shapes/Object/Object.ts:1740
hasCrop()
hasCrop():
boolean
Returns true if an image has crop applied, inspecting values of cropX,cropY,width,height.
Returns
boolean
Defined in
hasFill()
hasFill():
null|boolean|""
return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time We want it to be an approximation and be fast. wrote to avoid extra caching, it has to return true when fill happens, can guess when it will not happen at 100% chance, does not matter if it misses some use case where the fill is invisible.
Returns
null | boolean | ""
Boolean
Since
3.0.0
Inherited from
Defined in
src/shapes/Object/Object.ts:787
hasStroke()
hasStroke():
null|boolean|""
return true if the object will draw a stroke Does not consider text styles. This is just a shortcut used at rendering time We want it to be an approximation and be fast. wrote to avoid extra caching, it has to return true when stroke happens, can guess when it will not happen at 100% chance, does not matter if it misses some use case where the stroke is invisible.
Returns
null | boolean | ""
Boolean
Since
3.0.0
Inherited from
Defined in
src/shapes/Object/Object.ts:771
intersectsWithObject()
intersectsWithObject(
other):boolean
Checks if object intersects with another object
Parameters
• other: ObjectGeometry<ObjectEvents>
Object to test
Returns
boolean
true if object intersects with another object
Inherited from
FabricObject.intersectsWithObject
Defined in
src/shapes/Object/ObjectGeometry.ts:232
intersectsWithRect()
intersectsWithRect(
tl,br):boolean
Checks if object intersects with the scene rect formed by tl and br
Parameters
• tl: Point
• br: Point
Returns
boolean
Inherited from
FabricObject.intersectsWithRect
Defined in
src/shapes/Object/ObjectGeometry.ts:218
isCacheDirty()
isCacheDirty(
skipCanvas):boolean
Check if cache is dirty
Parameters
• skipCanvas: boolean = false
skip canvas checks because this object is painted on parent canvas.
Returns
boolean
Inherited from
Defined in
src/shapes/Object/Object.ts:956
isContainedWithinObject()
isContainedWithinObject(
other):boolean
Checks if object is fully contained within area of another object
Parameters
• other: ObjectGeometry<ObjectEvents>
Object to test
Returns
boolean
true if object is fully contained within area of another object
Inherited from
FabricObject.isContainedWithinObject
Defined in
src/shapes/Object/ObjectGeometry.ts:251
isContainedWithinRect()
isContainedWithinRect(
tl,br):boolean
Checks if object is fully contained within the scene rect formed by tl and br
Parameters
• tl: Point
• br: Point
Returns
boolean
Inherited from
FabricObject.isContainedWithinRect
Defined in
src/shapes/Object/ObjectGeometry.ts:259
isControlVisible()
isControlVisible(
controlKey):boolean
Returns true if the specified control is visible, false otherwise.
Parameters
• controlKey: string
The key of the control. Possible values are usually ‘tl’, ‘tr’, ‘br’, ‘bl’, ‘ml’, ‘mt’, ‘mr’, ‘mb’, ‘mtr’, but since the control api allow for any control name, can be any string.
Returns
boolean
true if the specified control is visible, false otherwise
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:584
isDescendantOf()
isDescendantOf(
target):boolean
Checks if object is descendant of target Should be used instead of Group.contains or StaticCanvas.contains for performance reasons
Parameters
• target: TAncestor
Returns
boolean
Inherited from
Defined in
src/shapes/Object/Object.ts:1644
isInFrontOf()
isInFrontOf<
T>(other):undefined|boolean
Type Parameters
• T extends FabricImage<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
Inherited from
Defined in
src/shapes/Object/Object.ts:1750
isNotVisible()
isNotVisible():
boolean
Returns
boolean
Inherited from
Defined in
src/shapes/Object/Object.ts:686
isOnScreen()
isOnScreen():
boolean
Checks if object is contained within the canvas with current viewportTransform the check is done stopping at first point that appears on screen
Returns
boolean
true if object is fully or partially contained within canvas
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:291
isOverlapping()
isOverlapping<
T>(other):boolean
Type Parameters
• T extends ObjectGeometry<ObjectEvents>
Parameters
• other: T
Returns
boolean
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:269
isPartiallyOnScreen()
isPartiallyOnScreen():
boolean
Checks if object is partially contained within the canvas with current viewportTransform
Returns
boolean
true if object is partially contained within canvas
Inherited from
FabricObject.isPartiallyOnScreen
Defined in
src/shapes/Object/ObjectGeometry.ts:321
isType()
isType(…
types):boolean
Returns true if any of the specified types is identical to the type of an instance
Parameters
• …types: string[]
Returns
boolean
Inherited from
Defined in
src/shapes/Object/Object.ts:1449
needsItsOwnCache()
needsItsOwnCache():
boolean
When set to true, force the object to have its own cache, even if it is inside a group
it may be needed when your object behave in a particular way on the cache and always needs
its own isolated canvas to render correctly.
Created to be overridden
since 1.7.12
Returns
boolean
Boolean
Inherited from
Defined in
src/shapes/Object/Object.ts:799
off()
off(eventName)
off<
K>(eventName):void
Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. We know we should have protected events for internal flows, but we don’t have yet
Type Parameters
• K extends string | number | symbol
Parameters
• eventName: K
event name (eg. ‘after:render’)
Returns
void
Inherited from
Defined in
off(eventName, handler)
off<
K>(eventName,handler):void
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
Defined in
off(handlers)
off(
handlers):void
unsubscribe event listeners
Parameters
• handlers: EventRegistryObject<EventSpec>
handlers key/value pairs (eg. {‘after:render’: handler, ‘selection:cleared’: handler})
Returns
void
Inherited from
Defined in
off()
off():
void
unsubscribe all event listeners
Returns
void
Inherited from
Defined in
on()
on(eventName, handler)
on<
K,E>(eventName,handler):VoidFunction
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
Defined in
on(handlers)
on(
handlers):VoidFunction
Parameters
• handlers: EventRegistryObject<EventSpec>
Returns
VoidFunction
Inherited from
Defined in
onDeselect()
onDeselect(
_options?):boolean
This callback function is called every time _discardActiveObject or _setActiveObject try to to deselect this object. If the function returns true, the process is cancelled
Parameters
• _options?
options sent from the upper functions
• _options.e?: TPointerEvent
• _options.object?: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>
Returns
boolean
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:658
onDragStart()
onDragStart(
_e):boolean
Override to customize Drag behavior
Fired once a drag session has started
Parameters
• _e: DragEvent
Returns
boolean
true to handle the drag event
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:691
onSelect()
onSelect(
_options?):boolean
This callback function is called every time _discardActiveObject or _setActiveObject try to to select this object. If the function returns true, the process is cancelled
Parameters
• _options?
options sent from the upper functions
• _options.e?: TPointerEvent
event if the process is generated by an event
Returns
boolean
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:672
once()
once(eventName, handler)
once<
K,E>(eventName,handler):VoidFunction
Observes specified event once
Type Parameters
• K extends 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
Defined in
once(handlers)
once(
handlers):VoidFunction
Parameters
• handlers: EventRegistryObject<EventSpec>
Returns
VoidFunction
Inherited from
Defined in
removeTexture()
removeTexture(
key):void
Delete a single texture if in webgl mode
Parameters
• key: string
Returns
void
Defined in
render()
render(
ctx):void
Renders an object on a specified context
Parameters
• ctx: CanvasRenderingContext2D
Context to render on
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:698
renderCache()
renderCache(
this,options?):void
Parameters
• this: TCachedFabricObject<BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>>
• options?: any
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:732
renderDragSourceEffect()
renderDragSourceEffect(
_e):void
Override to customize drag and drop behavior render a specific effect when an object is the source of a drag event example: render the selection status for the part of text that is being dragged from a text object
Parameters
• _e: DragEvent
Returns
void
Inherited from
FabricObject.renderDragSourceEffect
Defined in
src/shapes/Object/InteractiveObject.ts:712
renderDropTargetEffect()
renderDropTargetEffect(
_e):void
Override to customize drag and drop behavior render a specific effect when an object is the target of a drag event used to show that the underly object can receive a drop, or to show how the object will change when dropping. example: show the cursor where the text is about to be dropped
Parameters
• _e: DragEvent
Returns
void
Inherited from
FabricObject.renderDropTargetEffect
Defined in
src/shapes/Object/InteractiveObject.ts:724
rotate()
rotate(
angle):void
Sets “angle” of an instance with centered rotation
Parameters
• angle: TDegree
Angle value (in degrees)
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:1477
scale()
scale(
value):void
Scales an object (equally by x and y)
Parameters
• value: number
Scale factor
Returns
void
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:370
scaleToHeight()
scaleToHeight(
value):void
Scales an object to a given height, with respect to bounding box (scaling by x/y equally)
Parameters
• value: number
New height value
Returns
void
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:393
scaleToWidth()
scaleToWidth(
value):void
Scales an object to a given width, with respect to bounding box (scaling by x/y equally)
Parameters
• value: number
New width value
Returns
void
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:381
set()
set(
key,value?):FabricImage<Props,SProps,EventSpec>
Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) set does not update position of object’s borders/controls. If you need to update those, call setCoords().
Parameters
• key: string | Record<string, any>
Property name or object (if object, iterate over the object properties)
• value?: any
Property value (if function, the value is passed into it and its return value is used as a new one)
Returns
FabricImage<Props, SProps, EventSpec>
Inherited from
Defined in
setControlVisible()
setControlVisible(
controlKey,visible):void
Sets the visibility of the specified control. please do not use.
Parameters
• controlKey: string
The key of the control. Possible values are ‘tl’, ‘tr’, ‘br’, ‘bl’, ‘ml’, ‘mt’, ‘mr’, ‘mb’, ‘mtr’. but since the control api allow for any control name, can be any string.
• visible: boolean
true to set the specified control visible, false otherwise
Returns
void
Todo
discuss this overlap of priority here with the team. Andrea Bogazzi for details
Inherited from
FabricObject.setControlVisible
Defined in
src/shapes/Object/InteractiveObject.ts:599
setControlsVisibility()
setControlsVisibility(
options?):void
Sets the visibility state of object controls, this is just a bulk option for setControlVisible;
Parameters
• options?: Record<string, boolean> = {}
with an optional key per control example: {Boolean} [options.bl] true to enable the bottom-left control, false to disable it
Returns
void
Inherited from
FabricObject.setControlsVisibility
Defined in
src/shapes/Object/InteractiveObject.ts:611
setCoords()
setCoords():
void
set controls’ coordinates as well See https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords and http://fabricjs.com/fabric-gotchas
Returns
void
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:343
setElement()
setElement(
element,size?):void
Sets image element for this instance to a specified one.
If filters defined they are applied to new image.
You might need to call canvas.renderAll and object.setCoords after replacing, to render new image and update controls area.
Parameters
• element: ImageSource
• size?: Partial<TSize> = {}
Options object
Returns
void
Defined in
setOnGroup()
setOnGroup():
void
This callback function is called by the parent group of an object every time a non-delegated property changes on the group. It is passed the key and value as parameters. Not adding in this function’s signature to avoid Travis build error about unused variables.
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:1509
setPositionByOrigin()
setPositionByOrigin(
pos,originX,originY):void
Sets the position of the object taking into consideration the object’s origin
Parameters
• pos: Point
The new position of the object
• originX: TOriginX
Horizontal origin: ‘left’, ‘center’ or ‘right’
• originY: TOriginY
Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
void
Inherited from
FabricObject.setPositionByOrigin
Defined in
src/shapes/Object/ObjectGeometry.ts:777
setRelativeX()
setRelativeX(
value):void
Parameters
• value: number
x position according to object’s originX property in parent’s coordinate plane
if parent is canvas then this method is identical to setX
Returns
void
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:123
setRelativeXY()
setRelativeXY(
point,originX?,originY?):void
As setXY, but in current parent’s coordinate plane (the current group if any or the canvas)
Parameters
• point: Point
position according to object’s originX originY properties in parent’s coordinate plane
• originX?: TOriginX = ...
Horizontal origin: ‘left’, ‘center’ or ‘right’
• originY?: TOriginY = ...
Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
void
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:186
setRelativeY()
setRelativeY(
value):void
Parameters
• value: number
y position according to object’s originY property in parent’s coordinate plane
if parent is canvas then this property is identical to setY
Returns
void
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:139
setSrc()
setSrc(
src,options?):Promise<void>
Loads and sets source of an image
IMPORTANT: It is recommended to abort loading tasks before calling this method to prevent race conditions and unnecessary networking
Parameters
• src: string
Source string (URL)
• options?: LoadImageOptions = {}
Options object
Returns
Promise<void>
Defined in
setX()
setX(
value):void
Parameters
• value: number
x position according to object’s originX property in canvas coordinate plane
Returns
void
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:93
setXY()
setXY(
point,originX?,originY?):void
Set an object position to a particular point, the point is intended in absolute ( canvas ) coordinate. You can specify originX and originY values, that otherwise are the object’s current values.
Parameters
• point: Point
position in scene coordinate plane
• originX?: TOriginX
Horizontal origin: ‘left’, ‘center’ or ‘right’
• originY?: TOriginY
Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
void
Example
object.setXY(new Point(5, 5), 'left', 'bottom').Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:163
setY()
setY(
value):void
Parameters
• value: number
y position according to object’s originY property in canvas coordinate plane
Returns
void
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:107
shouldCache()
shouldCache():
boolean
Decide if the object should cache or not. Create its own cache level needsItsOwnCache should be used when the object drawing method requires a cache step. None of the fabric classes requires it. Generally you do not cache objects in groups because the group outside is cached. This is the special image version where we would like to avoid caching where possible. Essentially images do not benefit from caching. They may require caching, and in that case we do it. Also caching an image usually ends in a loss of details. A full performance audit should be done.
Returns
boolean
Overrides
Defined in
shouldStartDragging()
shouldStartDragging(
_e):boolean
Override to customize Drag behavior Fired from Canvas#_onMouseMove
Parameters
• _e: TPointerEvent
Returns
boolean
true in order for the window to start a drag session
Inherited from
FabricObject.shouldStartDragging
Defined in
src/shapes/Object/InteractiveObject.ts:682
strokeBorders()
strokeBorders(
ctx,size):void
override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style.
Parameters
• ctx: CanvasRenderingContext2D
ctx is rotated and translated so that (0,0) is at object’s center
• size: Point
the control box size used
Returns
void
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:399
toCanvasElement()
toCanvasElement(
options):HTMLCanvasElement
Converts an object into a HTMLCanvas element
Parameters
• options: ObjectToCanvasElementOptions = {}
Options object
Returns
HTMLCanvasElement
Returns DOM element
Inherited from
Defined in
src/shapes/Object/Object.ts:1340
toClipPathSVG()
toClipPathSVG(
this,reviver?):string
Returns svg clipPath representation of an instance
Parameters
• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>
• reviver?: TSVGReviver
Method for further parsing of svg representation.
Returns
string
svg representation of an instance
Inherited from
Defined in
src/shapes/Object/FabricObjectSVGExportMixin.ts:143
toDataURL()
toDataURL(
options):string
Converts an object into a data-url-like string
Parameters
• options: toDataURLOptions = {}
Options object
Returns
string
Returns a data: URL containing a representation of the object in the format specified by options.format
Inherited from
Defined in
src/shapes/Object/Object.ts:1436
toDatalessObject()
toDatalessObject(
propertiesToInclude?):any
Returns (dataless) object representation of an instance
Parameters
• propertiesToInclude?: any[]
Any properties that you might want to additionally include in the output
Returns
any
Object representation of an instance
Inherited from
Defined in
src/shapes/Object/Object.ts:1884
toJSON()
toJSON():
any
Returns a JSON representation of an instance
Returns
any
JSON
Inherited from
Defined in
src/shapes/Object/Object.ts:1468
toObject()
toObject<
T,K>(propertiesToInclude?):Pick<T,K> &SProps
Returns object representation of an instance
Type Parameters
• T extends Omit<Props & TClassProperties<FabricImage<Props, SProps, EventSpec>>, keyof SProps>
• K extends string | number | symbol = never
Parameters
• propertiesToInclude?: K[] = []
Any properties that you might want to additionally include in the output
Returns
Pick<T, K> & SProps
Object representation of an instance
Overrides
Defined in
toSVG()
toSVG(
this,reviver?):string
Returns svg representation of an instance
Parameters
• this: FabricObjectSVGExportMixin & FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>
• reviver?: TSVGReviver
Method for further parsing of svg representation.
Returns
string
svg representation of an instance
Inherited from
Defined in
src/shapes/Object/FabricObjectSVGExportMixin.ts:129
toString()
toString():
string
Returns string representation of an instance
Returns
string
String representation of an instance
Overrides
Defined in
toggle()
toggle(
property):FabricImage<Props,SProps,EventSpec>
Toggles specified property from true to false or from false to true
Parameters
• property: string
Property to toggle
Returns
FabricImage<Props, SProps, EventSpec>
Inherited from
Defined in
transform()
transform(
ctx):void
Transforms context when rendering an object
Parameters
• ctx: CanvasRenderingContext2D
Context
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:564
transformMatrixKey()
transformMatrixKey(
skipGroup):number[]
Parameters
• skipGroup: boolean = false
Returns
number[]
Inherited from
FabricObject.transformMatrixKey
Defined in
src/shapes/Object/ObjectGeometry.ts:453
translateToCenterPoint()
translateToCenterPoint(
point,originX,originY):Point
Translates the coordinates from origin to center coordinates (based on the object’s dimensions)
Parameters
• point: Point
The point which corresponds to the originX and originY params
• originX: TOriginX
Horizontal origin: ‘left’, ‘center’ or ‘right’
• originY: TOriginY
Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Inherited from
FabricObject.translateToCenterPoint
Defined in
src/shapes/Object/ObjectGeometry.ts:682
translateToGivenOrigin()
translateToGivenOrigin(
point,fromOriginX,fromOriginY,toOriginX,toOriginY):Point
Translates the coordinates from a set of origin to another (based on the object’s dimensions)
Parameters
• point: Point
The point which corresponds to the originX and originY params
• fromOriginX: TOriginX
Horizontal origin: ‘left’, ‘center’ or ‘right’
• fromOriginY: TOriginY
Vertical origin: ‘top’, ‘center’ or ‘bottom’
• toOriginX: TOriginX
Horizontal origin: ‘left’, ‘center’ or ‘right’
• toOriginY: TOriginY
Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Inherited from
FabricObject.translateToGivenOrigin
Defined in
src/shapes/Object/ObjectGeometry.ts:654
translateToOriginPoint()
translateToOriginPoint(
center,originX,originY):Point
Translates the coordinates from center to origin coordinates (based on the object’s dimensions)
Parameters
• center: Point
The point which corresponds to center of the object
• originX: TOriginX
Horizontal origin: ‘left’, ‘center’ or ‘right’
• originY: TOriginY
Vertical origin: ‘top’, ‘center’ or ‘bottom’
Returns
Inherited from
FabricObject.translateToOriginPoint
Defined in
src/shapes/Object/ObjectGeometry.ts:710
willDrawShadow()
willDrawShadow():
boolean
Check if this object will cast a shadow with an offset. used by Group.shouldCache to know if child has a shadow recursively
Returns
boolean
Inherited from
Defined in
src/shapes/Object/Object.ts:836
_fromObject()
static_fromObject<S>(__namedParameters,__namedParameters):Promise<S>
Type Parameters
• S extends BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>
Parameters
• __namedParameters: Record<string, unknown>
• __namedParameters: Abortable & object = {}
Returns
Promise<S>
Inherited from
Defined in
src/shapes/Object/Object.ts:1937
createControls()
staticcreateControls():object
Creates the default control object. If you prefer to have on instance of controls shared among all objects make this function return an empty object and add controls to the ownDefaults
Returns
object
controls
controls:
Record<string,Control>
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:167
fromElement()
staticfromElement(element,options?,cssRules?):Promise<null|FabricImage<Partial<ImageProps>,SerializedImageProps,ObjectEvents>>
Returns FabricImage instance from an SVG element
Parameters
• element: HTMLElement
Element to parse
• options?: Abortable = {}
Options object
• cssRules?: CSSRules
Returns
Promise<null | FabricImage<Partial<ImageProps>, SerializedImageProps, ObjectEvents>>
Static
Defined in
fromObject()
staticfromObject<T>(object,options?):Promise<FabricImage<Omit<T,"type"|"filters"|"resizeFilter"|"src"|"crossOrigin"> &object,SerializedImageProps,ObjectEvents>>
Creates an instance of FabricImage from its object representation
Type Parameters
• T extends TOptions<SerializedImageProps>
Parameters
• object: T
Object to create an instance from
• options?: Abortable
Options object
Returns
Promise<FabricImage<Omit<T, "type" | "filters" | "resizeFilter" | "src" | "crossOrigin"> & object, SerializedImageProps, ObjectEvents>>
Static
Overrides
Defined in
fromURL()
staticfromURL<T>(url,__namedParameters?,imageOptions?):Promise<FabricImage<Partial<ImageProps>,SerializedImageProps,ObjectEvents>>
Creates an instance of Image from an URL string
Type Parameters
• T extends TOptions<ImageProps>
Parameters
• url: string
URL to create an image from
• __namedParameters?: LoadImageOptions = {}
• imageOptions?: T
Returns
Promise<FabricImage<Partial<ImageProps>, SerializedImageProps, ObjectEvents>>
Static
Defined in
getDefaults()
staticgetDefaults():Record<string,any>
Returns
Record<string, any>