Textbox
Textbox class, based on IText, allows the user to resize the text rectangle and wraps lines automatically. Textboxes have their Y scaling locked, the user can only change width. Height is adjusted automatically based on the wrapping of lines.
Extends
IText<Props,SProps,EventSpec>
Type Parameters
• Props extends TOptions<TextboxProps> = Partial<TextboxProps>
• SProps extends SerializedTextboxProps = SerializedTextboxProps
• EventSpec extends ITextEvents = ITextEvents
Implements
UniqueTextboxProps
Constructors
new Textbox()
new Textbox<
Props,SProps,EventSpec>(text,options?):Textbox<Props,SProps,EventSpec>
Constructor
Parameters
• text: string
Text string
• options?: Props
Options object
Returns
Textbox<Props, SProps, EventSpec>
Overrides
Defined in
Properties
MIN_TEXT_WIDTH
MIN_TEXT_WIDTH:
number
contains the min text width to avoid getting 0
Default
Inherited from
Defined in
__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
__lineHeights
__lineHeights:
number[]
Inherited from
Defined in
__lineWidths
__lineWidths:
number[]
Inherited from
Defined in
_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
Defined in
src/shapes/Object/InteractiveObject.ts:112
_fontSizeMult
_fontSizeMult:
number
Text Line proportion to font Size (in pixels)
Default
Inherited from
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
_styleMap
_styleMap:
StyleMap
Defined in
_text
_text:
string[]
Inherited from
Defined in
_textLines
_textLines:
string[][]
same as textlines, but each line is an array of graphemes as split by splitByGrapheme
Default
Inherited from
Defined in
_unwrappedTextLines
_unwrappedTextLines:
string[][]
Inherited from
Defined in
_wordJoiners
_wordJoiners:
RegExp
Implementation of
UniqueTextboxProps._wordJoiners
Defined in
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
falseInherited from
Defined in
src/shapes/Object/Object.ts:218
angle
angle:
TDegree
Angle of rotation of an object (in degrees)
Default
0Inherited 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
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)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
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.4Inherited from
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
1Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:77
caching
caching:
boolean
Indicates whether internal text char widths can be cached
Default
Inherited from
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
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
Inherited from
Defined in
src/shapes/Object/Object.ts:220
charSpacing
charSpacing:
number
additional space between characters expressed in thousands of em unit
Default
Inherited from
Defined in
clipPath?
optionalclipPath:BaseFabricObject<Partial<ObjectProps>,SerializedObjectProps,ObjectEvents>
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
compositionColor
compositionColor:
string
Inherited from
Defined in
compositionEnd
compositionEnd:
number
Inherited from
Defined in
compositionStart
compositionStart:
number
Inherited from
Defined in
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)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
nullInherited from
Defined in
src/shapes/Object/InteractiveObject.ts:71
cornerSize
cornerSize:
number
Size of object’s controlling corners (in pixels)
Default
13Inherited 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
''Inherited from
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'Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:70
ctrlKeysMapDown
ctrlKeysMapDown:
TKeyMapIText
For functionalities on keyDown + ctrl || cmd
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:42
ctrlKeysMapUp
ctrlKeysMapUp:
TKeyMapIText
For functionalities on keyUp + ctrl || cmd
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:37
cursorColor
cursorColor:
string
Color of text cursor color in editing mode. if not set (default) will take color from the text. if set to a color value that fabric can understand, it will be used instead of the color of the text at the current position.
Default
Inherited from
Defined in
cursorDelay
cursorDelay:
number
Delay between cursor blink (in ms)
Default
Inherited from
Defined in
cursorDuration
cursorDuration:
number
Duration of cursor fade in (in ms)
Default
Inherited from
Defined in
cursorWidth
cursorWidth:
number
Width of cursor (in px)
Default
Inherited from
Defined in
deltaY
deltaY:
number
Baseline shift, styles only, keep at 0 for the main text object
Default
Inherited from
Defined in
direction
direction:
CanvasDirection
WARNING: EXPERIMENTAL. NOT SUPPORTED YET determine the direction of the text. This has to be set manually together with textAlign and originX for proper experience. some interesting link for the future https://www.w3.org/International/questions/qa-bidi-unicode-controls
Since
4.5.0
Default
Inherited from
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
dynamicMinWidth
dynamicMinWidth:
number
Minimum calculated width of a textbox, in pixels. fixed to 2 so that an empty textbox cannot go to 0 and is still selectable without text.
Default
Implementation of
UniqueTextboxProps.dynamicMinWidth
Defined in
editable
editable:
boolean
Indicates whether a text can be edited
Default
Inherited from
Defined in
editingBorderColor
editingBorderColor:
string
Border color of text object while it’s in editing mode
Default
Inherited from
Defined in
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
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
Inherited from
Defined in
src/shapes/Object/Object.ts:212
fill
fill:
null|string|TFiller
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
nonzeroInherited from
Defined in
src/shapes/Object/Object.ts:196
flipX
flipX:
boolean
When true, an object is rendered as flipped horizontally
Default
falseInherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:567
flipY
flipY:
boolean
When true, an object is rendered as flipped vertically
Default
falseInherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:568
fontFamily
fontFamily:
string
Font family
Default
Inherited from
Defined in
fontSize
fontSize:
number
Font size (in pixels)
Default
Inherited from
Defined in
fontStyle
fontStyle:
string
Font style . Possible values: "", “normal”, “italic” or “oblique”.
Default
Inherited from
Defined in
fontWeight
fontWeight:
string|number
Font weight (e.g. bold, normal, 400, 600, 800)
Default
Inherited from
Defined in
globalCompositeOperation
globalCompositeOperation:
GlobalCompositeOperation
Composite rule used for canvas globalCompositeOperation
Default
Inherited from
IText.globalCompositeOperation
Defined in
src/shapes/Object/Object.ts:204
hasBorders
hasBorders:
boolean
When set to false, object’s controlling borders are not rendered
Default
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
trueInherited from
Defined in
src/shapes/Object/InteractiveObject.ts:72
height
height:
number
Object height
Default
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:566
hiddenTextarea
hiddenTextarea:
null|HTMLTextAreaElement
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:44
hiddenTextareaContainer?
optionalhiddenTextareaContainer:null|HTMLElement
DOM container to append the hiddenTextarea. An alternative to attaching to the document.body. Useful to reduce laggish redraw of the full document.body tree and also with modals event capturing that won’t let the textarea take focus.
Default
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:54
hoverCursor
hoverCursor:
null|string
Default cursor value used when hovering over this object on canvas
Default
nullInherited from
Defined in
src/shapes/Object/InteractiveObject.ts:86
includeDefaultValues
includeDefaultValues:
boolean
When false, default object’s values are not included in its serialization
Default
Inherited from
Defined in
src/shapes/Object/Object.ts:211
initialized?
optionalinitialized:true
Inherited from
Defined in
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
falseInherited from
Defined in
src/shapes/Object/Object.ts:217
isEditing
isEditing:
boolean
Indicates whether text is in editing mode
Default
Inherited from
Defined in
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
isWrapping
isWrapping:
boolean
Defined in
keysMap
keysMap:
TKeyMapIText
For functionalities on keyDown Map a special key to a function of the instance/prototype If you need different behavior for ESC or TAB or arrows, you have to change this map setting the name of a function that you build on the IText or your prototype. the map change will affect all Instances unless you need for only some text Instances in that case you have to clone this object and assign your Instance. this.keysMap = Object.assign({}, this.keysMap); The function must be in IText.prototype.myFunction And will receive event as args[0]
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:30
keysMapRtl
keysMapRtl:
TKeyMapIText
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:32
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
0Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:564
lineHeight
lineHeight:
number
Line height
Default
Inherited from
Defined in
linethrough
linethrough:
boolean
Text decoration linethrough.
Default
Inherited from
Defined in
lockMovementX
lockMovementX:
boolean
When true, object horizontal movement is locked
Default
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:56
lockMovementY
lockMovementY:
boolean
When true, object vertical movement is locked
Default
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:57
lockRotation
lockRotation:
boolean
When true, object rotation is locked
Default
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
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:63
lockScalingX
lockScalingX:
boolean
When true, object horizontal scaling is locked
Default
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:59
lockScalingY
lockScalingY:
boolean
When true, object vertical scaling is locked
Default
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:60
lockSkewingX
lockSkewingX:
boolean
When true, object horizontal skewing is locked
Default
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:61
lockSkewingY
lockSkewingY:
boolean
When true, object vertical skewing is locked
Default
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
0Inherited from
Defined in
src/shapes/Object/Object.ts:190
minWidth
minWidth:
number
Minimum width of textbox, in pixels.
Default
Implementation of
UniqueTextboxProps.minWidth
Defined in
moveCursor
moveCursor:
null|string
Default cursor value used when moving this object on canvas
Default
nullInherited 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
trueInherited 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
trueInherited from
Defined in
src/shapes/Object/Object.ts:214
opacity
opacity:
number
Opacity of an object
Default
1Inherited from
Defined in
src/shapes/Object/Object.ts:192
originX
originX:
TOriginX
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:576
originY
originY:
TOriginY
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:580
overline
overline:
boolean
Text decoration overline.
Default
Inherited from
Defined in
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
0Inherited 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
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
path?
optionalpath:Path<Partial<PathProps>,SerializedPathProps,ObjectEvents>
Path that the text should follow. since 4.6.0 the path will be drawn automatically. if you want to make the path visible, give it a stroke and strokeWidth or fill value if you want it to be hidden, assign visible = false to the path. This feature is in BETA, and SVG import/export is not yet supported.
Example
const textPath = new Text('Text on a path', { top: 150, left: 150, textAlign: 'center', charSpacing: -50, path: new Path('M 0 0 C 50 -100 150 -100 200 0', { strokeWidth: 1, visible: false }), pathSide: 'left', pathStartOffset: 0});Default
Inherited from
Defined in
pathAlign
pathAlign:
TPathAlign
How text is aligned to the path. This property determines the perpendicular position of each character relative to the path. (one of “baseline”, “center”, “ascender”, “descender”) This feature is in BETA, and its behavior may change
Default
Inherited from
Defined in
pathSide
pathSide:
TPathSide
Which side of the path the text should be drawn on. Only used when text has a path
Default
Inherited from
Defined in
pathStartOffset
pathStartOffset:
number
Offset amount for text path starting position Only used when text has a path
Default
Inherited from
Defined in
perPixelTargetFind
perPixelTargetFind:
boolean
When set to true, objects are “found” on canvas on per-pixel basis rather than according to bounding box
Default
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:83
scaleX
scaleX:
number
Object scale factor (horizontal)
Default
1Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:569
scaleY
scaleY:
number
Object scale factor (vertical)
Default
1Inherited 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
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
Inherited from
IText.selectionBackgroundColor
Defined in
src/shapes/Object/InteractiveObject.ts:79
selectionColor
selectionColor:
string
Color of text selection
Default
Inherited from
Defined in
selectionEnd
selectionEnd:
number
Index where text selection ends
Default
Inherited from
Defined in
selectionStart
selectionStart:
number
Index where text selection starts (or where cursor is when there is no selection)
Default
Inherited from
Defined in
shadow
shadow:
null|Shadow
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
0Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:571
skewY
skewY:
number
Angle of skew on y axes of an object (in degrees)
Default
0Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:572
snapAngle?
optionalsnapAngle:TDegree
The angle that an object will lock to while rotating.
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.
Inherited from
Defined in
src/shapes/Object/InteractiveObject.ts:54
splitByGrapheme
splitByGrapheme:
boolean
Use this boolean property in order to split strings that have no white space concept. this is a cheap way to help with chinese/japanese
Since
2.6.0
Implementation of
UniqueTextboxProps.splitByGrapheme
Defined in
stroke
stroke:
null|string|TFiller
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;Inherited from
Defined in
src/shapes/Object/Object.ts:198
strokeDashOffset
strokeDashOffset:
number
Line offset of an object’s stroke
Default
0Inherited 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
buttInherited 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
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
4Inherited 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
falseInherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:583
strokeWidth
strokeWidth:
number
Width of a stroke used to render this object
Default
1Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:582
styles
styles:
TextStyle
Inherited from
Defined in
subscript
subscript:
object
Subscript schema object (minimum overlap)
baseline
baseline:
number
baseline-shift factor (downwards)
Default
0.11size
size:
number
fontSize factor
Default
0.6Inherited from
Defined in
superscript
superscript:
object
Superscript schema object (minimum overlap)
baseline
baseline:
number
baseline-shift factor (upwards)
Default
-0.35size
size:
number
fontSize factor
Default
0.6Inherited from
Defined in
text
text:
string
Inherited from
Defined in
textAlign
textAlign:
string
Text alignment. Possible values: “left”, “center”, “right”, “justify”, “justify-left”, “justify-center” or “justify-right”.
Default
Inherited from
Defined in
textBackgroundColor
textBackgroundColor:
string
Background color of text lines
Default
Inherited from
Defined in
textLines
textLines:
string[]
contains the the text of the object, divided in lines as they are displayed on screen. Wrapping will divide the text independently of line breaks
Default
Inherited from
Defined in
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
0Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:563
touchCornerSize
touchCornerSize:
number
Size of object’s controlling corners when touch interaction is detected
Default
24Inherited 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
trueInherited from
Defined in
src/shapes/Object/InteractiveObject.ts:67
underline
underline:
boolean
Text decoration underline.
Default
Inherited from
Defined in
visible
visible:
boolean
When set to false, an object is not rendered on canvas
Default
Inherited from
Defined in
src/shapes/Object/Object.ts:209
width
width:
number
Object width
Default
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 FabricText.fromElement)
Static
Member Of
Text @see: http://www.w3.org/TR/SVG/text.html#TextElement
Inherited from
Defined in
_styleProperties
static_styleProperties: readonlyStylePropertiesType[] =styleProperties
Inherited from
Defined in
src/shapes/Text/StyledText.ts:30
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
Inherited from
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
genericFonts
staticgenericFonts:string[]
List of generic font families
See
https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#generic-name
Inherited from
Defined in
ownDefaults
staticownDefaults:Partial<TClassProperties<Textbox<Partial<TextboxProps>,SerializedTextboxProps,ITextEvents>>> =textboxDefaultValues
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='Textbox'
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
Returns
string
Inherited from
Defined in
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
_getFontDeclaration()
_getFontDeclaration(
__namedParameters?,forMeasuring?):string
return font declaration string for canvas context
Parameters
• __namedParameters?: Partial<Pick<Partial<CompleteTextStyleDeclaration>, "fontFamily" | "fontSize" | "fontStyle" | "fontWeight">> = {}
• forMeasuring?: boolean
Returns
string
font declaration formatted for canvas context.
Inherited from
Defined in
_getGraphemeBox()
_getGraphemeBox(
grapheme,lineIndex,charIndex,prevGrapheme?,skipLeft?):GraphemeBBox
Parameters
• grapheme: string
to be measured
• lineIndex: number
index of the line where the char is
• charIndex: number
position in the line
• prevGrapheme?: string
character preceding the one to be measured
• skipLeft?: boolean
Returns
grapheme bbox
Inherited from
Defined in
_getSelectionForOffset()
_getSelectionForOffset(
e,isRight):number
private Helps finding if the offset should be counted from Start or End
Parameters
• e: KeyboardEvent
Event object
• isRight: boolean
Returns
number
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:377
_getWidthOfCharSpacing()
_getWidthOfCharSpacing():
number
Returns
number
Inherited from
Defined in
_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
_measureLine()
_measureLine(
lineIndex):object
measure every grapheme of a line, populating __charBounds
Parameters
• lineIndex: number
Returns
object
object.width total width of characters
object.numOfSpaces length of chars that match this._reSpacesAndTabs
numOfSpaces
numOfSpaces:
number=0
width
width:
number
Inherited from
Defined in
_measureWord()
_measureWord(
word,lineIndex,charOffset):number
Helper function to measure a string of text, given its lineIndex and charIndex offset It gets called when charBounds are not available yet. Override if necessary Use with Textbox#wordSplit
Parameters
• word: string[]
• lineIndex: number
• charOffset: number = 0
Returns
number
Defined in
_mouseDownHandler()
_mouseDownHandler(
__namedParameters):void
Default event handler for the basic functionalities needed on _mouseDown can be overridden to do something different. Scope of this implementation is: find the click position, set selectionStart find selectionEnd, initialize the drawing of either cursor or selection area initializing a mousedDown on a text area will cancel fabricjs knowledge of current compositionMode. It will be set to false.
Parameters
• __namedParameters: TPointerEventInfo<TPointerEvent>
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:136
_mouseDownHandlerBefore()
_mouseDownHandlerBefore(
__namedParameters):void
Default event handler for the basic functionalities needed on mousedown:before can be overridden to do something different. Scope of this implementation is: verify the object is already selected when mousing down
Parameters
• __namedParameters: TPointerEventInfo<TPointerEvent>
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:171
_moveCursorLeftOrRight()
_moveCursorLeftOrRight(
direction,e):void
Moves cursor right or Left, fires event
Parameters
• direction: "Left" | "Right"
‘Left’, ‘Right’
• e: KeyboardEvent
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:639
_moveCursorUpOrDown()
_moveCursorUpOrDown(
direction,e):void
Moves cursor up or down, fires the events
Parameters
• direction: "Up" | "Down"
‘Up’ or ‘Down’
• e: KeyboardEvent
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:477
_removeCacheCanvas()
_removeCacheCanvas():
void
Remove cacheCanvas and its dimensions from the objects
Returns
void
Inherited from
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
_renderCursor()
_renderCursor(
ctx,boundaries,selectionStart):void
Render the cursor at the given selectionStart.
Parameters
• ctx: CanvasRenderingContext2D
• boundaries: CursorBoundaries
• selectionStart: number
Returns
void
Inherited from
Defined in
_setClippingProperties()
_setClippingProperties(
ctx):void
Parameters
• ctx: CanvasRenderingContext2D
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:1062
_setFillStyles()
_setFillStyles(
ctx,style):object
This function prepare the canvas for a ill style, and fill need to be sent in as defined
Parameters
• ctx: CanvasRenderingContext2D
• style: Pick<Textbox<Props, SProps, EventSpec>, "fill">
with ill defined
Returns
object
offsetX
offsetX:
number
offsetY
offsetY:
number
Inherited from
Defined in
_setStrokeStyles()
_setStrokeStyles(
ctx,style):object
This function prepare the canvas for a stroke style, and stroke and strokeWidth need to be sent in as defined
Parameters
• ctx: CanvasRenderingContext2D
• style: Pick<CompleteTextStyleDeclaration, "stroke" | "strokeWidth">
with stroke and strokeWidth defined
Returns
object
offsetX
offsetX:
number
offsetY
offsetY:
number
Inherited from
Defined in
_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
IText._setupCompositeOperation
Defined in
src/shapes/Object/Object.ts:1518
_splitTextIntoLines()
_splitTextIntoLines(
text):TextLinesInfo
Gets lines of text to render in the Textbox. This function calculates text wrapping on the fly every time it is called.
Parameters
• text: string
text to split
Returns
TextLinesInfo
Array of lines in the Textbox.
Overrides
Defined in
_toSVG()
_toSVG(
_reviver?):string[]
Returns svg representation of an instance This function is implemented in each subclass This is just because typescript otherwise cryies all the time
Parameters
• _reviver?: TSVGReviver
Returns
string[]
an array of strings with the specific svg representation of the instance
Inherited from
Defined in
src/shapes/Object/FabricObjectSVGExportMixin.ts:120
_wrapText()
_wrapText(
lines,desiredWidth):string[][]
Wraps text using the ‘width’ property of Textbox. First this function splits text on newlines, so we preserve newlines entered by the user. Then it wraps each line using the width of the Textbox by calling _wrapLine().
Parameters
• lines: string[]
The string array of text that is split into lines
• desiredWidth: number
width you want to wrap to
Returns
string[][]
Array of lines
Defined in
abortCursorAnimation()
abortCursorAnimation():
void
Aborts cursor animation, clears all timeouts and clear textarea context if necessary
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:183
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
blur()
blur():
void
Override this method to customize cursor behavior on textbox blur
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:106
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
calcTextHeight()
calcTextHeight():
number
Calculate text box height
Returns
number
Inherited from
Defined in
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
Defined in
src/shapes/Object/ObjectGeometry.ts:485
canDrop()
canDrop(
e):boolean
override this method to control whether instance should/shouldn’t become a drop target
Parameters
• e: DragEvent
Returns
boolean
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:75
cleanStyle()
cleanStyle(
property):undefined|false
Check if characters in a text have a value for a property whose value matches the textbox’s value for that property. If so, the character-level property is deleted. If the character has no other properties, then it is also deleted. Finally, if the line containing that character has no other characters then it also is deleted.
Parameters
• property: StylePropertiesType
The property to compare between characters and text.
Returns
undefined | false
Inherited from
Defined in
src/shapes/Text/StyledText.ts:103
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<Textbox<Props,SProps,EventSpec>>
Clones an instance.
Parameters
• propertiesToInclude?: string[]
Any properties that you might want to additionally include in the output
Returns
Promise<Textbox<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
Inherited from
Defined in
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
copy()
copy():
void
Copies selected text
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:295
dispose()
dispose():
void
cancel instance’s running animations
override if necessary to dispose artifacts such as clipPath
Returns
void
Inherited from
Defined in
doubleClickHandler()
doubleClickHandler(
options):void
Default handler for double click, select a word
Parameters
• options: TPointerEventInfo<TPointerEvent>
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:111
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.
Parameters
• this: TCachedFabricObject<BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>>
• ctx: CanvasRenderingContext2D
Context to render on
Returns
void
Inherited from
Defined in
src/shapes/Object/Object.ts:942
drawClipPathOnCache()
drawClipPathOnCache(
ctx,clipPath,canvasWithClipPath):void
Execute the drawing operation for an object clipPath
Parameters
• ctx: CanvasRenderingContext2D
Context to render on
• clipPath: BaseFabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>
• canvasWithClipPath: HTMLCanvasElement
Returns
void
Inherited from
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
IText.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
Defined in
src/shapes/Object/InteractiveObject.ts:375
enlargeSpaces()
enlargeSpaces():
void
Enlarge space boxes and shift the others
Returns
void
Inherited from
Defined in
enterEditing()
enterEditing(
e?):void
Enters editing state
Parameters
• e?: TPointerEvent
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:386
enterEditingImpl()
enterEditingImpl():
void
runs the actual logic that enter from editing state, see enterEditing
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:405
exitEditing()
exitEditing():
Textbox<Props,SProps,EventSpec>
Exits from editing state and fires relevant events
Returns
Textbox<Props, SProps, EventSpec>
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:715
exitEditingImpl()
exitEditingImpl():
void
runs the actual logic that exits from editing state, see exitEditing But it does not fire events
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:702
findCommonAncestors()
findCommonAncestors<
T>(other):AncestryComparison
Compare ancestors
Type Parameters
• T extends Textbox<Props, SProps, EventSpec>
Parameters
• other: T
Returns
AncestryComparison
an object that represent the ancestry situation.
Inherited from
Defined in
src/shapes/Object/Object.ts:1675
findLineBoundaryLeft()
findLineBoundaryLeft(
startFrom):number
Find new selection index representing start of current line according to current selection index
Parameters
• startFrom: number
Current selection index
Returns
number
New selection index
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:288
findLineBoundaryRight()
findLineBoundaryRight(
startFrom):number
Find new selection index representing end of current line according to current selection index
Parameters
• startFrom: number
Current selection index
Returns
number
New selection index
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:305
findWordBoundaryLeft()
findWordBoundaryLeft(
startFrom):number
Find new selection index representing start of current word according to current selection index
Parameters
• startFrom: number
Current selection index
Returns
number
New selection index
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:240
findWordBoundaryRight()
findWordBoundaryRight(
startFrom):number
Find new selection index representing end of current word according to current selection index
Parameters
• startFrom: number
Current selection index
Returns
number
New selection index
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:264
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
fromGraphemeToStringSelection()
fromGraphemeToStringSelection(
start,end,graphemes):object
convert from fabric to textarea values
Parameters
• start: number
• end: number
• graphemes: string[]
Returns
object
selectionEnd
selectionEnd:
number=graphemeStart
selectionStart
selectionStart:
number=graphemeStart
Inherited from
IText.fromGraphemeToStringSelection
Defined in
src/shapes/IText/ITextBehavior.ts:498
fromStringToGraphemeSelection()
fromStringToGraphemeSelection(
start,end,text):object
convert from textarea to grapheme indexes
Parameters
• start: number
• end: number
• text: string
Returns
object
selectionEnd
selectionEnd:
number=graphemeStart
selectionStart
selectionStart:
number=graphemeStart
Inherited from
IText.fromStringToGraphemeSelection
Defined in
src/shapes/IText/ITextBehavior.ts:481
get()
get(
property):any
Basic getter
Parameters
• property: string
Property name
Returns
any
value of a property
Inherited from
Defined in
get2DCursorLocation()
get2DCursorLocation(
selectionStart?,skipWrapping?):object
Returns 2d representation (lineIndex and charIndex) of cursor (or selection start)
Parameters
• selectionStart?: number = ...
Optional index. When not given, current selectionStart is used.
• skipWrapping?: boolean
consider the location for unwrapped lines. useful to manage styles.
Returns
object
charIndex
charIndex:
number=selectionStart
lineIndex
lineIndex:
number=i
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
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
getCompleteStyleDeclaration()
getCompleteStyleDeclaration(
lineIndex,charIndex):CompleteTextStyleDeclaration
return a new object that contains all the style property for a character the object returned is newly created
Parameters
• lineIndex: number
of the line where the character is
• charIndex: number
position of the character on the line
Returns
style object
Inherited from
IText.getCompleteStyleDeclaration
Defined in
src/shapes/Text/StyledText.ts:279
getCoords()
getCoords():
Point[]
Returns
Point[]
[tl, tr, br, bl] in the scene plane
Inherited from
Defined in
src/shapes/Object/ObjectGeometry.ts:204
getCurrentCharColor()
getCurrentCharColor():
null|string|TFiller
High level function to know the color of the cursor. the currentChar is the one that precedes the cursor Returns color (fill) of char at the current cursor if the text object has a pattern or gradient for filler, it will return that. Unused by the library, is for the end user
Returns
null | string | TFiller
Character color (fill)
Inherited from
Defined in
getCurrentCharFontSize()
getCurrentCharFontSize():
number
High level function to know the height of the cursor. the currentChar is the one that precedes the cursor Returns fontSize of char at the current cursor Unused from the library, is for the end user
Returns
number
Character font size
Inherited from
Defined in
getCursorRenderingData()
getCursorRenderingData(
selectionStart,boundaries):CursorRenderingData
Return the data needed to render the cursor for given selection start The left,top are relative to the object, while width and height are prescaled to look think with canvas zoom and object scaling, so they depend on canvas and object scaling
Parameters
• selectionStart: number = ...
• boundaries: CursorBoundaries = ...
Returns
Inherited from
Defined in
getDownCursorOffset()
getDownCursorOffset(
e,isRight):number
Gets start offset of a selection
Parameters
• e: KeyboardEvent
Event object
• isRight: boolean
Returns
number
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:345
getGraphemeDataForRender()
getGraphemeDataForRender(
lines):GraphemeData
For each line of text terminated by an hard line stop, measure each word width and extract the largest word from all. The returned words here are the one that at the end will be rendered.
Parameters
• lines: string[]
the lines we need to measure
Returns
Defined in
getHeightOfChar()
getHeightOfChar(
line,_char):number
Computes height of character at given position
Parameters
• line: number
the line index number
• _char: number
the character index number
Returns
number
fontSize of the character
Inherited from
Defined in
getHeightOfLine()
getHeightOfLine(
lineIndex):number
Calculate height of line at ‘lineIndex’
Parameters
• lineIndex: number
index of line to calculate
Returns
number
Inherited from
Defined in
getMinWidth()
getMinWidth():
number
Returns
number
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
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
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
getSelectedText()
getSelectedText():
string
Returns selected text
Returns
string
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:231
getSelectionStartFromPointer()
getSelectionStartFromPointer(
e):number
Returns index of a character corresponding to where an object was clicked
Parameters
• e: TPointerEvent
Event object
Returns
number
Index of a character
Inherited from
IText.getSelectionStartFromPointer
Defined in
src/shapes/IText/ITextClickBehavior.ts:246
getSelectionStyles()
getSelectionStyles(
startIndex,endIndex,complete?):Partial<CompleteTextStyleDeclaration>[]
Gets style of a current selection/cursor (at the start position) if startIndex or endIndex are not provided, selectionStart or selectionEnd will be used.
Parameters
• startIndex: number = ...
Start index to get styles at
• endIndex: number = ...
End index to get styles at, if not specified selectionEnd or startIndex + 1
• complete?: boolean
get full style or not
Returns
Partial<CompleteTextStyleDeclaration>[]
styles an array with one, zero or more Style objects
Inherited from
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
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
Defined in
src/shapes/Object/Object.ts:593
getUpCursorOffset()
getUpCursorOffset(
e,isRight):number
Parameters
• e: KeyboardEvent
Event object
• isRight: boolean
Returns
number
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:390
getValueOfPropertyAt()
getValueOfPropertyAt<
T>(lineIndex,charIndex,property):Textbox<Props,SProps,EventSpec>[T]
Retrieves the value of property at given character position
Type Parameters
• T extends StylePropertiesType
Parameters
• lineIndex: number
the line number
• charIndex: number
the character number
• property: T
the property name
Returns
Textbox<Props, SProps, EventSpec>[T]
the value of ‘property’
Inherited from
Defined in
getViewportTransform()
getViewportTransform():
TMat2D
Retrieves viewportTransform from Object’s canvas if available
Returns
Inherited from
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
graphemeSplit()
graphemeSplit(
value):string[]
Override this method to customize grapheme splitting
Parameters
• value: string
Returns
string[]
array of graphemes
Todo
the util graphemeSplit needs to be injectable in some way.
is more comfortable to inject the correct util rather than having to override text
in the middle of the prototype chain
Inherited from
Defined in
handleFiller()
handleFiller<
T>(ctx,property,filler):object
Type Parameters
• T extends "fill" | "stroke"
Parameters
• ctx: CanvasRenderingContext2D
• property: `${T}Style`
• filler: string | TFiller
Returns
object
offsetX
offsetX:
number
offsetY
offsetY:
number
Inherited from
Defined in
hasCommonAncestors()
hasCommonAncestors<
T>(other):boolean
Type Parameters
• T extends Textbox<Props, SProps, EventSpec>
Parameters
• other: T
Returns
boolean
Inherited from
Defined in
src/shapes/Object/Object.ts:1740
hasFill()
hasFill():
null|boolean|""
return true if the object will draw a fill Does not consider text styles. This is just a shortcut used at rendering time We want it to be an approximation and be fast. wrote to avoid extra caching, it has to return true when fill happens, can guess when it will not happen at 100% chance, does not matter if it misses some use case where the fill is invisible.
Returns
null | boolean | ""
Boolean
Since
3.0.0
Inherited from
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
initBehavior()
initBehavior():
void
Initializes all the interactive behavior of IText
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:30
initDelayedCursor()
initDelayedCursor(
restart?):void
Initializes delayed cursor
Parameters
• restart?: boolean
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:175
initHiddenTextarea()
initHiddenTextarea():
void
Initializes hidden textarea (needed to bring up keyboard in iOS)
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:63
insertCharStyleObject()
insertCharStyleObject(
lineIndex,charIndex,quantity,copiedStyle?):void
Inserts style object for a given line/char index
Parameters
• lineIndex: number
Index of a line
• charIndex: number
Index of a char
• quantity: number
number Style object to insert, if given
• copiedStyle?: Partial<CompleteTextStyleDeclaration>[]
array of style objects
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:901
insertChars()
insertChars(
text,style,start,end):void
insert characters at start position, before start position. start equal 1 it means the text get inserted between actual grapheme 0 and 1 if style array is provided, it must be as the same length of text in graphemes if end is provided and is bigger than start, old text is replaced. start/end ar per grapheme position in _text array.
Parameters
• text: string
text to insert
• style: undefined | Partial<CompleteTextStyleDeclaration>[]
array of style objects
• start: number
• end: number = start
default to start + 1
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:1051
insertNewStyleBlock()
insertNewStyleBlock(
insertedText,start,copiedStyle?):void
Inserts style object(s)
Parameters
• insertedText: string[]
Characters at the location where style is inserted
• start: number
cursor index for inserting style
• copiedStyle?: Partial<CompleteTextStyleDeclaration>[]
array of style objects to insert.
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:959
insertNewlineStyleObject()
insertNewlineStyleObject(
lineIndex,charIndex,qty,copiedStyle?):void
Handle insertion of more consecutive style lines for when one or more newlines gets added to the text. Since current style needs to be shifted first we shift the current style of the number lines needed, then we add new lines from the last to the first.
Parameters
• lineIndex: number
Index of a line
• charIndex: number
Index of a char
• qty: number
number of lines to add
• copiedStyle?
Array of objects styles
Returns
void
Inherited from
IText.insertNewlineStyleObject
Defined in
src/shapes/IText/ITextBehavior.ts:832
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
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
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
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
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
isEmptyStyles()
isEmptyStyles(
lineIndex):boolean
Returns true if object has no styling or no styling in a line
Parameters
• lineIndex: number
, lineIndex is on wrapped lines.
Returns
boolean
Overrides
Defined in
isEndOfWrapping()
isEndOfWrapping(
lineIndex):boolean
Detect if the text line is ended with an hard break text and itext do not have wrapping, return false
Parameters
• lineIndex: number
text to split
Returns
boolean
Overrides
Defined in
isInFrontOf()
isInFrontOf<
T>(other):undefined|boolean
Type Parameters
• T extends Textbox<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
Defined in
src/shapes/Object/ObjectGeometry.ts:321
isTripleClick()
isTripleClick(
newPointer):boolean
Parameters
• newPointer: XY
Returns
boolean
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:99
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
measureLine()
measureLine(
lineIndex):object
measure a text line measuring all characters.
Parameters
• lineIndex: number
line number
Returns
object
numOfSpaces
numOfSpaces:
number=0
width
width:
number
Inherited from
Defined in
missingNewlineOffset()
missingNewlineOffset(
lineIndex,skipWrapping?):0|1
Detect if a line has a linebreak and so we need to account for it when moving and counting style. This is important only for splitByGrapheme at the end of wrapping. If we are not wrapping the offset is always 1
Parameters
• lineIndex: number
• skipWrapping?: boolean
Returns
0 | 1
Number
Overrides
Defined in
moveCursorDown()
moveCursorDown(
e):void
Moves cursor down
Parameters
• e: KeyboardEvent
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:451
moveCursorLeft()
moveCursorLeft(
e):void
Moves cursor left
Parameters
• e: KeyboardEvent
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:536
moveCursorLeftWithShift()
moveCursorLeftWithShift(
e):undefined|boolean
Moves cursor left while keeping selection
Parameters
• e: KeyboardEvent
Returns
undefined | boolean
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:608
moveCursorLeftWithoutShift()
moveCursorLeftWithoutShift(
e):boolean
Moves cursor left without keeping selection
Parameters
• e: KeyboardEvent
Returns
boolean
Inherited from
IText.moveCursorLeftWithoutShift
Defined in
src/shapes/IText/ITextKeyBehavior.ts:588
moveCursorRight()
moveCursorRight(
e):void
Moves cursor right
Parameters
• e: KeyboardEvent
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:624
moveCursorRightWithShift()
moveCursorRightWithShift(
e):undefined|boolean
Moves cursor right while keeping selection
Parameters
• e: KeyboardEvent
Returns
undefined | boolean
Inherited from
IText.moveCursorRightWithShift
Defined in
src/shapes/IText/ITextKeyBehavior.ts:658
moveCursorRightWithoutShift()
moveCursorRightWithoutShift(
e):boolean
Moves cursor right without keeping selection
Parameters
• e: KeyboardEvent
Event object
Returns
boolean
Inherited from
IText.moveCursorRightWithoutShift
Defined in
src/shapes/IText/ITextKeyBehavior.ts:674
moveCursorUp()
moveCursorUp(
e):void
Moves cursor up
Parameters
• e: KeyboardEvent
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:465
moveCursorWithShift()
moveCursorWithShift(
offset):boolean
Moves cursor with shift
Parameters
• offset: number
Returns
boolean
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:504
moveCursorWithoutShift()
moveCursorWithoutShift(
offset):boolean
Moves cursor up without shift
Parameters
• offset: number
Returns
boolean
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:521
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
onCompositionEnd()
onCompositionEnd():
void
Composition end
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:281
onCompositionStart()
onCompositionStart():
void
Composition start
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:274
onCompositionUpdate()
onCompositionUpdate(
__namedParameters):void
Parameters
• __namedParameters: CompositionEvent
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:285
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.e?: TPointerEvent
event if the process is generated by an event
• options.object?: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>
next object we are setting as active, and reason why this is being deselected
Returns
boolean
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:111
onDragStart()
onDragStart(
e):boolean
override this method to control whether instance should/shouldn’t become a drag source,
Parameters
• e: DragEvent
Returns
boolean
should handle event
See
also DraggableTextDelegate#isActive To prevent drag and drop between objects both shouldStartDragging and onDragStart should return false
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:68
onInput()
onInput(
this,e):void
Handles onInput event
Parameters
• this: Textbox<Props, SProps, EventSpec> & object
• e: Event
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:167
onKeyDown()
onKeyDown(
e):void
Handles keydown event only used for arrows and combination of modifier keys.
Parameters
• e: KeyboardEvent
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:115
onKeyUp()
onKeyUp(
e):void
Handles keyup event We handle KeyUp because ie11 and edge have difficulties copy/pasting if a copy/cut event fired, keyup is dismissed
Parameters
• e: KeyboardEvent
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:147
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
paste()
paste():
void
Pastes text
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextKeyBehavior.ts:317
removeChars()
removeChars(
start,end):void
Removes characters from start/end start/end ar per grapheme position in _text array.
Parameters
• start: number
• end: number = ...
default to start + 1
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:1029
removeStyle()
removeStyle(
property):void
Remove a style property or properties from all individual character styles in a text object. Deletes the character style object if it contains no other style props. Deletes a line style object if it contains no other character styles.
Parameters
• property: StylePropertiesType
Returns
void
Inherited from
Defined in
src/shapes/Text/StyledText.ts:165
removeStyleFromTo()
removeStyleFromTo(
start,end):void
remove and reflow a style block from start to end.
Parameters
• start: number
linear start position for removal (included in removal)
• end: number
linear end position for removal ( excluded from removal )
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:747
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
renderCursor()
renderCursor(
ctx,boundaries):void
Renders cursor
Parameters
• ctx: CanvasRenderingContext2D
transformed context to draw on
• boundaries: CursorBoundaries
Returns
void
Inherited from
Defined in
renderCursorAt()
renderCursorAt(
selectionStart):void
Renders cursor on context Top, outside the animation cycle, on request Used for the drag/drop effect. If contextTop is not available, do nothing.
Parameters
• selectionStart: number
Returns
void
Inherited from
Defined in
renderCursorOrSelection()
renderCursorOrSelection():
void
Renders cursor or selection (depending on what exists) it does on the contextTop. If contextTop is not available, do nothing.
Returns
void
Inherited from
Defined in
renderDragSourceEffect()
renderDragSourceEffect():
void
Renders drag start text selection
Returns
void
Inherited from
Defined in
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
Defined in
renderSelection()
renderSelection(
ctx,boundaries):void
Renders text selection
Parameters
• ctx: CanvasRenderingContext2D
transformed context to draw on
• boundaries: CursorBoundaries
Object with left/top/leftOffset/topOffset
Returns
void
Inherited from
Defined in
restartCursorIfNeeded()
restartCursorIfNeeded():
void
Restart tue cursor animation if either is in complete state ( between animations ) or if it never started before
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:206
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
searchWordBoundary()
searchWordBoundary(
selectionStart,direction):number
Finds index corresponding to beginning or end of a word
Parameters
• selectionStart: number
Index of a character
• direction: -1 | 1
1 or -1
Returns
number
Index of the beginning or end of a word
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:323
selectAll()
selectAll():
Textbox<Props,SProps,EventSpec>
Selects entire text
Returns
Textbox<Props, SProps, EventSpec>
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:219
selectLine()
selectLine(
selectionStart?):Textbox<Props,SProps,EventSpec>
TODO fix: selectionStart set as 0 will be ignored? Selects a line based on the index
Parameters
• selectionStart?: number
Index of a character
Returns
Textbox<Props, SProps, EventSpec>
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:371
selectWord()
selectWord(
selectionStart?):void
TODO fix: selectionStart set as 0 will be ignored? Selects a word based on the index
Parameters
• selectionStart?: number
Index of a character
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:349
set()
set(
key,value?):Textbox<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: 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
Textbox<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
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
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
setCursorByClick()
setCursorByClick(
e):void
Changes cursor location in a text depending on passed pointer (x/y) object
Parameters
• e: TPointerEvent
Event object
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:225
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
setPathInfo()
setPathInfo():
void
If text has a path, it will add the extra information needed for path and text calculations
Returns
void
Inherited from
Defined in
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
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
setSelectionEnd()
setSelectionEnd(
index):void
Sets selection end (right boundary of a selection)
Parameters
• index: number
Index to set selection end to
Returns
void
Inherited from
Defined in
setSelectionStart()
setSelectionStart(
index):void
Sets selection start (left boundary of a selection)
Parameters
• index: number
Index to set selection start to
Returns
void
Inherited from
Defined in
setSelectionStartEndWithShift()
setSelectionStartEndWithShift(
start,end,newSelection):void
Set the selectionStart and selectionEnd according to the new position of cursor mimic the key - mouse navigation when shift is pressed.
Parameters
• start: number
• end: number
• newSelection: number
Returns
void
Inherited from
IText.setSelectionStartEndWithShift
Defined in
src/shapes/IText/ITextBehavior.ts:1078
setSelectionStyles()
setSelectionStyles(
styles?,startIndex?,endIndex?):void
Sets style of a current selection, if no selection exist, do not set anything.
Parameters
• styles?: object
Styles object
• startIndex?: number = ...
Start index to get styles at
• endIndex?: number = ...
End index to get styles at, if not specified selectionEnd or startIndex + 1
Returns
void
Inherited from
Defined in
setSubscript()
setSubscript(
start,end):void
Turns the character into an ‘inferior figure’ (i.e. ‘subscript’)
Parameters
• start: number
selection start
• end: number
selection end
Returns
void
Inherited from
Defined in
setSuperscript()
setSuperscript(
start,end):void
Turns the character into a ‘superior figure’ (i.e. ‘superscript’)
Parameters
• start: number
selection start
• end: number
selection end
Returns
void
Inherited from
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
shiftLineStyles()
shiftLineStyles(
lineIndex,offset):void
Shifts line styles up or down
Parameters
• lineIndex: number
Index of a line
• offset: number
Can any number?
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextBehavior.ts:809
shouldCache()
shouldCache():
boolean
Decide if the object should cache or not. Create its own cache level objectCaching is a global flag, wins over everything needsItsOwnCache should be used when the object drawing method requires a cache step. None of the fabric classes requires it. Generally you do not cache objects in groups because the group outside is cached. Read as: cache if is needed, or if the feature is enabled but we are not already caching.
Returns
boolean
Inherited from
Defined in
src/shapes/Object/Object.ts:823
shouldStartDragging()
shouldStartDragging():
boolean
If this method returns true a mouse move operation over a text selection will not prevent the native mouse event allowing the browser to start a drag operation. shouldStartDragging can be read ‘do not prevent default for mouse move event’ To prevent drag and drop between objects both shouldStartDragging and onDragStart should return false
Returns
boolean
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:58
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
styleHas()
styleHas(
property,lineIndex):boolean
Returns true if object has a style property or has it on a specified line
Parameters
• property: StylePropertiesType
• lineIndex: number
Returns
boolean
Overrides
Defined in
toCanvasElement()
toCanvasElement(
options?):HTMLCanvasElement
block cursor/selection logic while rendering the exported canvas
Parameters
• options?: ObjectToCanvasElementOptions
Returns
HTMLCanvasElement
Todo
this workaround should be replaced with a more robust solution
Inherited from
Defined in
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<Textbox<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
Method
toObject
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 text object
Inherited from
Defined in
toggle()
toggle(
property):Textbox<Props,SProps,EventSpec>
Toggles specified property from true to false or from false to true
Parameters
• property: string
Property to toggle
Returns
Textbox<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
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
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
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
Defined in
src/shapes/Object/ObjectGeometry.ts:710
tripleClickHandler()
tripleClickHandler(
options):void
Default handler for triple click, select a line
Parameters
• options: TPointerEventInfo<TPointerEvent>
Returns
void
Inherited from
Defined in
src/shapes/IText/ITextClickBehavior.ts:121
updateSelectionOnMouseMove()
updateSelectionOnMouseMove(
e):void
called by Canvas#textEditingManager
Parameters
• e: TPointerEvent
Returns
void
Inherited from
IText.updateSelectionOnMouseMove
Defined in
src/shapes/IText/ITextBehavior.ts:427
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
wordSplit()
wordSplit(
value):string[]
Override this method to customize word splitting Use with Textbox#_measureWord
Parameters
• value: string
Returns
string[]
array of words
Defined in
_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 object
Returns
object
controls
controls:
Record<string,Control>
Overrides
Defined in
fromElement()
staticfromElement(element,options?,cssRules?):Promise<FabricText<object,SerializedTextProps,ObjectEvents>>
Returns FabricText instance from an SVG element (not yet implemented)
Parameters
• element: HTMLElement
Element to parse
• options?: Abortable
Options object
• cssRules?: CSSRules
Returns
Promise<FabricText<object, SerializedTextProps, ObjectEvents>>
Static
Member Of
Text
Inherited from
Defined in
fromObject()
staticfromObject<T,S>(object):Promise<S>
Returns FabricText instance from an object representation
Type Parameters
• T extends TOptions<SerializedTextProps>
• S extends FabricText<Partial<TextProps>, SerializedTextProps, ObjectEvents>
Parameters
• object: T
plain js Object to create an instance from
Returns
Promise<S>
Inherited from
Defined in
getDefaults()
staticgetDefaults():Record<string,any>
Returns
Record<string, any>