Skip to content

SerializedTextProps

Extends

Extended by

Properties

angle

angle: TDegree

Angle of rotation of an object (in degrees)

Default

0

Inherited from

SerializedObjectProps.angle

Defined in

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

backgroundColor

backgroundColor: string

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

Default

Inherited from

SerializedObjectProps.backgroundColor

Defined in

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

charSpacing

charSpacing: number

Inherited from

UniqueTextProps.charSpacing

Defined in

src/shapes/Text/Text.ts:94

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

SerializedObjectProps.clipPath

Defined in

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

direction

direction: CanvasDirection

Inherited from

UniqueTextProps.direction

Defined in

src/shapes/Text/Text.ts:106

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

SerializedObjectProps.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

SerializedObjectProps.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

SerializedObjectProps.flipX

Defined in

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

flipY

flipY: boolean

When true, an object is rendered as flipped vertically

Default

false

Inherited from

SerializedObjectProps.flipY

Defined in

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

fontFamily

fontFamily: string

Inherited from

UniqueTextProps.fontFamily

Defined in

src/shapes/Text/Text.ts:98

fontSize

fontSize: number

Inherited from

UniqueTextProps.fontSize

Defined in

src/shapes/Text/Text.ts:96

fontStyle

fontStyle: string

Inherited from

UniqueTextProps.fontStyle

Defined in

src/shapes/Text/Text.ts:99

fontWeight

fontWeight: string | number

Inherited from

UniqueTextProps.fontWeight

Defined in

src/shapes/Text/Text.ts:97

globalCompositeOperation

globalCompositeOperation: GlobalCompositeOperation

Composite rule used for canvas globalCompositeOperation

Default

Inherited from

SerializedObjectProps.globalCompositeOperation

Defined in

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

height

height: number

Object height

Default

Inherited from

SerializedObjectProps.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

SerializedObjectProps.left

Defined in

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

lineHeight

lineHeight: number

Inherited from

UniqueTextProps.lineHeight

Defined in

src/shapes/Text/Text.ts:95

linethrough

linethrough: boolean

Inherited from

UniqueTextProps.linethrough

Defined in

src/shapes/Text/Text.ts:104

opacity

opacity: number

Opacity of an object

Default

1

Inherited from

SerializedObjectProps.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

SerializedObjectProps.originX

Defined in

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

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

SerializedObjectProps.originY

Defined in

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

overline

overline: boolean

Inherited from

UniqueTextProps.overline

Defined in

src/shapes/Text/Text.ts:103

paintFirst

paintFirst: "fill" | "stroke"

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

Default

Inherited from

SerializedObjectProps.paintFirst

Defined in

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

path?

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

Inherited from

UniqueTextProps.path

Defined in

src/shapes/Text/Text.ts:107

pathAlign

pathAlign: TPathAlign

Inherited from

UniqueTextProps.pathAlign

Defined in

src/shapes/Text/Text.ts:101

pathSide

pathSide: TPathSide

Inherited from

UniqueTextProps.pathSide

Defined in

src/shapes/Text/Text.ts:100

scaleX

scaleX: number

Object scale factor (horizontal)

Default

1

Inherited from

SerializedObjectProps.scaleX

Defined in

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

scaleY

scaleY: number

Object scale factor (vertical)

Default

1

Inherited from

SerializedObjectProps.scaleY

Defined in

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

shadow

shadow: null | Partial<SerializedShadowOptions>

Shadow object representing shadow of this shape

Default

null

Inherited from

SerializedObjectProps.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

SerializedObjectProps.skewX

Defined in

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

skewY

skewY: TDegree

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

Default

0

Inherited from

SerializedObjectProps.skewY

Defined in

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

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

SerializedObjectProps.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

SerializedObjectProps.strokeDashArray

Defined in

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

strokeDashOffset

strokeDashOffset: number

Line offset of an object’s stroke

Default

0

Inherited from

SerializedObjectProps.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

SerializedObjectProps.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

SerializedObjectProps.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

SerializedObjectProps.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

SerializedObjectProps.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

SerializedObjectProps.strokeWidth

Defined in

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

styles

styles: TextStyle | TextStyleArray

Defined in

src/shapes/Text/Text.ts:113

textAlign

textAlign: string

Inherited from

UniqueTextProps.textAlign

Defined in

src/shapes/Text/Text.ts:105

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

SerializedObjectProps.top

Defined in

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

underline

underline: boolean

Inherited from

UniqueTextProps.underline

Defined in

src/shapes/Text/Text.ts:102

visible

visible: boolean

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

Default

Inherited from

SerializedObjectProps.visible

Defined in

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

width

width: number

Object width

Default

Inherited from

SerializedObjectProps.width

Defined in

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