SerializedTextboxProps
Defined in: src/shapes/Textbox.ts:42
Extends
Section titled “Extends”SerializedITextProps.Pick<UniqueTextboxProps,"minWidth"|"splitByGrapheme">
Properties
Section titled “Properties”angle:
TDegree
Defined in: src/shapes/Object/types/BaseProps.ts:63
Angle of rotation of an object (in degrees)
Default
Section titled “Default”0Inherited from
Section titled “Inherited from”backgroundColor
Section titled “backgroundColor”backgroundColor:
string
Defined in: src/shapes/Object/types/SerializedObjectProps.ts:26
Background color of an object. takes css colors https://www.w3.org/TR/css-color-3/
Default
Section titled “Default”Inherited from
Section titled “Inherited from”SerializedITextProps.backgroundColor
charSpacing
Section titled “charSpacing”charSpacing:
number
Defined in: src/shapes/Text/Text.ts:96
Inherited from
Section titled “Inherited from”SerializedITextProps.charSpacing
clipPath?
Section titled “clipPath?”
optionalclipPath:Partial<SerializedObjectProps&ClipPathProps>
Defined in: src/shapes/Object/types/SerializedObjectProps.ts:49
a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the object has rendered, and the context is placed in the center of the object cacheCanvas. If you want 0,0 of a clipPath to align with an object center, use clipPath.originX/Y to ‘center’
Inherited from
Section titled “Inherited from”direction
Section titled “direction”direction:
CanvasDirection
Defined in: src/shapes/Text/Text.ts:108
Inherited from
Section titled “Inherited from”SerializedITextProps.direction
fill:
null|string|Record<string,any> |Partial<Gradient<"linear","linear">> &object|Partial<Gradient<"radial","radial">> &object
Defined in: src/shapes/Object/types/FillStrokeProps.ts:17
Color of object’s fill takes css colors https://www.w3.org/TR/css-color-3/
Default
Section titled “Default”rgb(0,0,0)Inherited from
Section titled “Inherited from”fillRule
Section titled “fillRule”fillRule:
CanvasFillRule
Defined in: src/shapes/Object/types/FillStrokeProps.ts:26
Fill rule used to fill an object
accepted values are nonzero, evenodd
Backwards incompatibility note: This property was used for setting globalCompositeOperation until v1.4.12 (use globalCompositeOperation instead)
Default
Section titled “Default”nonzeroInherited from
Section titled “Inherited from”flipX:
boolean
Defined in: src/shapes/Object/types/BaseProps.ts:70
When true, an object is rendered as flipped horizontally
Default
Section titled “Default”falseInherited from
Section titled “Inherited from”flipY:
boolean
Defined in: src/shapes/Object/types/BaseProps.ts:77
When true, an object is rendered as flipped vertically
Default
Section titled “Default”falseInherited from
Section titled “Inherited from”fontFamily
Section titled “fontFamily”fontFamily:
string
Defined in: src/shapes/Text/Text.ts:100
Inherited from
Section titled “Inherited from”SerializedITextProps.fontFamily
fontSize
Section titled “fontSize”fontSize:
number
Defined in: src/shapes/Text/Text.ts:98
Inherited from
Section titled “Inherited from”fontStyle
Section titled “fontStyle”fontStyle:
string
Defined in: src/shapes/Text/Text.ts:101
Inherited from
Section titled “Inherited from”SerializedITextProps.fontStyle
fontWeight
Section titled “fontWeight”fontWeight:
string|number
Defined in: src/shapes/Text/Text.ts:99
Inherited from
Section titled “Inherited from”SerializedITextProps.fontWeight
globalCompositeOperation
Section titled “globalCompositeOperation”globalCompositeOperation:
GlobalCompositeOperation
Defined in: src/shapes/Object/types/SerializedObjectProps.ts:18
Composite rule used for canvas globalCompositeOperation
Default
Section titled “Default”Inherited from
Section titled “Inherited from”SerializedITextProps.globalCompositeOperation
height
Section titled “height”height:
number
Defined in: src/shapes/Object/types/BaseProps.ts:34
Object height
Default
Section titled “Default”Inherited from
Section titled “Inherited from”left:
number
Defined in: src/shapes/Object/types/BaseProps.ts:11
Left position of an object. Note that by default it’s relative to object left. You can change this by setting FabricObject#originX
Default
Section titled “Default”0Inherited from
Section titled “Inherited from”lineHeight
Section titled “lineHeight”lineHeight:
number
Defined in: src/shapes/Text/Text.ts:97
Inherited from
Section titled “Inherited from”SerializedITextProps.lineHeight
linethrough
Section titled “linethrough”linethrough:
boolean
Defined in: src/shapes/Text/Text.ts:106
Inherited from
Section titled “Inherited from”SerializedITextProps.linethrough
minWidth
Section titled “minWidth”minWidth:
number
Defined in: src/shapes/Textbox.ts:36
Inherited from
Section titled “Inherited from”Pick.minWidth
opacity
Section titled “opacity”opacity:
number
Defined in: src/shapes/Object/types/SerializedObjectProps.ts:11
Opacity of an object
Default
Section titled “Default”1Inherited from
Section titled “Inherited from”originX
Section titled “originX”originX:
TOriginX
Defined in: src/shapes/Object/types/BaseProps.ts:45
Horizontal origin of transformation of an object (left, center, right or [0, 1])
See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups
Default
Section titled “Default”'left'Inherited from
Section titled “Inherited from”originY
Section titled “originY”originY:
TOriginY
Defined in: src/shapes/Object/types/BaseProps.ts:56
Vertical origin of transformation of an object (top, center, bottom or [0, 1])
See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups
Default
Section titled “Default”'top'Inherited from
Section titled “Inherited from”overline
Section titled “overline”overline:
boolean
Defined in: src/shapes/Text/Text.ts:105
Inherited from
Section titled “Inherited from”paintFirst
Section titled “paintFirst”paintFirst:
"fill"|"stroke"
Defined in: src/shapes/Object/types/FillStrokeProps.ts:9
Determines if the fill or the stroke is drawn first (one of “fill” or “stroke”)
Default
Section titled “Default”Inherited from
Section titled “Inherited from”SerializedITextProps.paintFirst
optionalpath:Path<Partial<PathProps>,SerializedPathProps,ObjectEvents>
Defined in: src/shapes/Text/Text.ts:109
Inherited from
Section titled “Inherited from”pathAlign
Section titled “pathAlign”pathAlign:
TPathAlign
Defined in: src/shapes/Text/Text.ts:103
Inherited from
Section titled “Inherited from”SerializedITextProps.pathAlign
pathSide
Section titled “pathSide”pathSide:
TPathSide
Defined in: src/shapes/Text/Text.ts:102
Inherited from
Section titled “Inherited from”scaleX
Section titled “scaleX”scaleX:
number
Defined in: src/shapes/Object/types/BaseProps.ts:84
Object scale factor (horizontal)
Default
Section titled “Default”1Inherited from
Section titled “Inherited from”scaleY
Section titled “scaleY”scaleY:
number
Defined in: src/shapes/Object/types/BaseProps.ts:91
Object scale factor (vertical)
Default
Section titled “Default”1Inherited from
Section titled “Inherited from”selectionEnd
Section titled “selectionEnd”selectionEnd:
number
Defined in: src/shapes/IText/IText.ts:71
Inherited from
Section titled “Inherited from”SerializedITextProps.selectionEnd
selectionStart
Section titled “selectionStart”selectionStart:
number
Defined in: src/shapes/IText/IText.ts:70
Inherited from
Section titled “Inherited from”SerializedITextProps.selectionStart
shadow
Section titled “shadow”shadow:
null|Partial<SerializedShadowOptions>
Defined in: src/shapes/Object/types/SerializedObjectProps.ts:33
Shadow object representing shadow of this shape
Default
Section titled “Default”nullInherited from
Section titled “Inherited from”skewX:
TDegree
Defined in: src/shapes/Object/types/BaseProps.ts:98
Angle of skew on x axes of an object (in degrees)
Default
Section titled “Default”0Inherited from
Section titled “Inherited from”skewY:
TDegree
Defined in: src/shapes/Object/types/BaseProps.ts:105
Angle of skew on y axes of an object (in degrees)
Default
Section titled “Default”0Inherited from
Section titled “Inherited from”splitByGrapheme
Section titled “splitByGrapheme”splitByGrapheme:
boolean
Defined in: src/shapes/Textbox.ts:37
Inherited from
Section titled “Inherited from”Pick.splitByGrapheme
stroke
Section titled “stroke”stroke:
null|string|Record<string,any> |Partial<Gradient<"linear","linear">> &object|Partial<Gradient<"radial","radial">> &object
Defined in: src/shapes/Object/types/FillStrokeProps.ts:34
When defined, an object is rendered via stroke and this property specifies its color takes css colors https://www.w3.org/TR/css-color-3/
Default
Section titled “Default”nullInherited from
Section titled “Inherited from”strokeDashArray
Section titled “strokeDashArray”strokeDashArray:
null|number[]
Defined in: src/shapes/Object/types/FillStrokeProps.ts:48
Array specifying dash pattern of an object’s stroke (stroke must be defined)
Default
Section titled “Default”null;Inherited from
Section titled “Inherited from”SerializedITextProps.strokeDashArray
strokeDashOffset
Section titled “strokeDashOffset”strokeDashOffset:
number
Defined in: src/shapes/Object/types/FillStrokeProps.ts:55
Line offset of an object’s stroke
Default
Section titled “Default”0Inherited from
Section titled “Inherited from”SerializedITextProps.strokeDashOffset
strokeLineCap
Section titled “strokeLineCap”strokeLineCap:
CanvasLineCap
Defined in: src/shapes/Object/types/FillStrokeProps.ts:62
Line endings style of an object’s stroke (one of “butt”, “round”, “square”)
Default
Section titled “Default”buttInherited from
Section titled “Inherited from”SerializedITextProps.strokeLineCap
strokeLineJoin
Section titled “strokeLineJoin”strokeLineJoin:
CanvasLineJoin
Defined in: src/shapes/Object/types/FillStrokeProps.ts:69
Corner style of an object’s stroke (one of “bevel”, “round”, “miter”)
Default
Section titled “Default”Inherited from
Section titled “Inherited from”SerializedITextProps.strokeLineJoin
strokeMiterLimit
Section titled “strokeMiterLimit”strokeMiterLimit:
number
Defined in: src/shapes/Object/types/FillStrokeProps.ts:76
Maximum miter length (used for strokeLineJoin = “miter”) of an object’s stroke
Default
Section titled “Default”4Inherited from
Section titled “Inherited from”SerializedITextProps.strokeMiterLimit
strokeUniform
Section titled “strokeUniform”strokeUniform:
boolean
Defined in: src/shapes/Object/types/FillStrokeProps.ts:89
When false, the stoke width will scale with the object.
When true, the stroke will always match the exact pixel size entered for stroke width.
this Property does not work on Text classes or drawing call that uses strokeText,fillText methods
default to false
2.6.0
Default
Section titled “Default”falseDefault
Section titled “Default”falseInherited from
Section titled “Inherited from”SerializedITextProps.strokeUniform
strokeWidth
Section titled “strokeWidth”strokeWidth:
number
Defined in: src/shapes/Object/types/FillStrokeProps.ts:41
Width of a stroke used to render this object
Default
Section titled “Default”1Inherited from
Section titled “Inherited from”SerializedITextProps.strokeWidth
styles
Section titled “styles”styles:
TextStyle|TextStyleArray
Defined in: src/shapes/Text/Text.ts:115
Inherited from
Section titled “Inherited from”textAlign
Section titled “textAlign”textAlign:
string
Defined in: src/shapes/Text/Text.ts:107
Inherited from
Section titled “Inherited from”SerializedITextProps.textAlign
top:
number
Defined in: src/shapes/Object/types/BaseProps.ts:20
Top position of an object. Note that by default it’s relative to object top. You can change this by setting FabricObject#originY
Default
Section titled “Default”0Inherited from
Section titled “Inherited from”underline
Section titled “underline”underline:
boolean
Defined in: src/shapes/Text/Text.ts:104
Inherited from
Section titled “Inherited from”SerializedITextProps.underline
visible
Section titled “visible”visible:
boolean
Defined in: src/shapes/Object/types/SerializedObjectProps.ts:40
When set to false, an object is not rendered on canvas
Default
Section titled “Default”Inherited from
Section titled “Inherited from”width:
number
Defined in: src/shapes/Object/types/BaseProps.ts:27
Object width
Default
Section titled “Default”