Skip to content

SerializedTextboxProps

Extends

Properties

angle

angle: TDegree

Angle of rotation of an object (in degrees)

Default

0

Inherited from

SerializedITextProps.angle

Defined in

src/shapes/Object/types/BaseProps.ts:63

backgroundColor

backgroundColor: string

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

Default

Inherited from

SerializedITextProps.backgroundColor

Defined in

src/shapes/Object/types/SerializedObjectProps.ts:26

charSpacing

charSpacing: number

Inherited from

SerializedITextProps.charSpacing

Defined in

src/shapes/Text/Text.ts:96

clipPath?

optional clipPath: Partial<SerializedObjectProps & ClipPathProps>

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

SerializedITextProps.clipPath

Defined in

src/shapes/Object/types/SerializedObjectProps.ts:49

direction

direction: CanvasDirection

Inherited from

SerializedITextProps.direction

Defined in

src/shapes/Text/Text.ts:108

fill

fill: null | string | Record<string, any> | Partial<Gradient<"linear", "linear">> & object | Partial<Gradient<"radial", "radial">> & object

Color of object’s fill takes css colors https://www.w3.org/TR/css-color-3/

Default

rgb(0,0,0)

Inherited from

SerializedITextProps.fill

Defined in

src/shapes/Object/types/FillStrokeProps.ts:17

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

nonzero

Inherited from

SerializedITextProps.fillRule

Defined in

src/shapes/Object/types/FillStrokeProps.ts:26

flipX

flipX: boolean

When true, an object is rendered as flipped horizontally

Default

false

Inherited from

SerializedITextProps.flipX

Defined in

src/shapes/Object/types/BaseProps.ts:70

flipY

flipY: boolean

When true, an object is rendered as flipped vertically

Default

false

Inherited from

SerializedITextProps.flipY

Defined in

src/shapes/Object/types/BaseProps.ts:77

fontFamily

fontFamily: string

Inherited from

SerializedITextProps.fontFamily

Defined in

src/shapes/Text/Text.ts:100

fontSize

fontSize: number

Inherited from

SerializedITextProps.fontSize

Defined in

src/shapes/Text/Text.ts:98

fontStyle

fontStyle: string

Inherited from

SerializedITextProps.fontStyle

Defined in

src/shapes/Text/Text.ts:101

fontWeight

fontWeight: string | number

Inherited from

SerializedITextProps.fontWeight

Defined in

src/shapes/Text/Text.ts:99

globalCompositeOperation

globalCompositeOperation: GlobalCompositeOperation

Composite rule used for canvas globalCompositeOperation

Default

Inherited from

SerializedITextProps.globalCompositeOperation

Defined in

src/shapes/Object/types/SerializedObjectProps.ts:18

height

height: number

Object height

Default

Inherited from

SerializedITextProps.height

Defined in

src/shapes/Object/types/BaseProps.ts:34

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

0

Inherited from

SerializedITextProps.left

Defined in

src/shapes/Object/types/BaseProps.ts:11

lineHeight

lineHeight: number

Inherited from

SerializedITextProps.lineHeight

Defined in

src/shapes/Text/Text.ts:97

linethrough

linethrough: boolean

Inherited from

SerializedITextProps.linethrough

Defined in

src/shapes/Text/Text.ts:106

minWidth

minWidth: number

Inherited from

Pick.minWidth

Defined in

src/shapes/Textbox.ts:36

opacity

opacity: number

Opacity of an object

Default

1

Inherited from

SerializedITextProps.opacity

Defined in

src/shapes/Object/types/SerializedObjectProps.ts:11

originX

originX: TOriginX

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

'left'

Inherited from

SerializedITextProps.originX

Defined in

src/shapes/Object/types/BaseProps.ts:45

originY

originY: TOriginY

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

'top'

Inherited from

SerializedITextProps.originY

Defined in

src/shapes/Object/types/BaseProps.ts:56

overline

overline: boolean

Inherited from

SerializedITextProps.overline

Defined in

src/shapes/Text/Text.ts:105

paintFirst

paintFirst: "fill" | "stroke"

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

Default

Inherited from

SerializedITextProps.paintFirst

Defined in

src/shapes/Object/types/FillStrokeProps.ts:9

path?

optional path: Path<Partial<PathProps>, SerializedPathProps, ObjectEvents>

Inherited from

SerializedITextProps.path

Defined in

src/shapes/Text/Text.ts:109

pathAlign

pathAlign: TPathAlign

Inherited from

SerializedITextProps.pathAlign

Defined in

src/shapes/Text/Text.ts:103

pathSide

pathSide: TPathSide

Inherited from

SerializedITextProps.pathSide

Defined in

src/shapes/Text/Text.ts:102

scaleX

scaleX: number

Object scale factor (horizontal)

Default

1

Inherited from

SerializedITextProps.scaleX

Defined in

src/shapes/Object/types/BaseProps.ts:84

scaleY

scaleY: number

Object scale factor (vertical)

Default

1

Inherited from

SerializedITextProps.scaleY

Defined in

src/shapes/Object/types/BaseProps.ts:91

selectionEnd

selectionEnd: number

Inherited from

SerializedITextProps.selectionEnd

Defined in

src/shapes/IText/IText.ts:68

selectionStart

selectionStart: number

Inherited from

SerializedITextProps.selectionStart

Defined in

src/shapes/IText/IText.ts:67

shadow

shadow: null | Partial<SerializedShadowOptions>

Shadow object representing shadow of this shape

Default

null

Inherited from

SerializedITextProps.shadow

Defined in

src/shapes/Object/types/SerializedObjectProps.ts:33

skewX

skewX: TDegree

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

Default

0

Inherited from

SerializedITextProps.skewX

Defined in

src/shapes/Object/types/BaseProps.ts:98

skewY

skewY: TDegree

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

Default

0

Inherited from

SerializedITextProps.skewY

Defined in

src/shapes/Object/types/BaseProps.ts:105

splitByGrapheme

splitByGrapheme: boolean

Inherited from

Pick.splitByGrapheme

Defined in

src/shapes/Textbox.ts:37

stroke

stroke: null | string | Record<string, any> | Partial<Gradient<"linear", "linear">> & object | Partial<Gradient<"radial", "radial">> & object

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

null

Inherited from

SerializedITextProps.stroke

Defined in

src/shapes/Object/types/FillStrokeProps.ts:34

strokeDashArray

strokeDashArray: null | number[]

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

Default

null;

Inherited from

SerializedITextProps.strokeDashArray

Defined in

src/shapes/Object/types/FillStrokeProps.ts:48

strokeDashOffset

strokeDashOffset: number

Line offset of an object’s stroke

Default

0

Inherited from

SerializedITextProps.strokeDashOffset

Defined in

src/shapes/Object/types/FillStrokeProps.ts:55

strokeLineCap

strokeLineCap: CanvasLineCap

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

Default

butt

Inherited from

SerializedITextProps.strokeLineCap

Defined in

src/shapes/Object/types/FillStrokeProps.ts:62

strokeLineJoin

strokeLineJoin: CanvasLineJoin

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

Default

Inherited from

SerializedITextProps.strokeLineJoin

Defined in

src/shapes/Object/types/FillStrokeProps.ts:69

strokeMiterLimit

strokeMiterLimit: number

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

Default

4

Inherited from

SerializedITextProps.strokeMiterLimit

Defined in

src/shapes/Object/types/FillStrokeProps.ts:76

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

false

Default

false

Inherited from

SerializedITextProps.strokeUniform

Defined in

src/shapes/Object/types/FillStrokeProps.ts:89

strokeWidth

strokeWidth: number

Width of a stroke used to render this object

Default

1

Inherited from

SerializedITextProps.strokeWidth

Defined in

src/shapes/Object/types/FillStrokeProps.ts:41

styles

styles: TextStyle | TextStyleArray

Inherited from

SerializedITextProps.styles

Defined in

src/shapes/Text/Text.ts:115

textAlign

textAlign: string

Inherited from

SerializedITextProps.textAlign

Defined in

src/shapes/Text/Text.ts:107

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

0

Inherited from

SerializedITextProps.top

Defined in

src/shapes/Object/types/BaseProps.ts:20

underline

underline: boolean

Inherited from

SerializedITextProps.underline

Defined in

src/shapes/Text/Text.ts:104

visible

visible: boolean

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

Default

Inherited from

SerializedITextProps.visible

Defined in

src/shapes/Object/types/SerializedObjectProps.ts:40

width

width: number

Object width

Default

Inherited from

SerializedITextProps.width

Defined in

src/shapes/Object/types/BaseProps.ts:27