SerializedObjectProps

Extends

• BaseProps.FillStrokeProps

Extended by

• SerializedLineProps
• SerializedCircleProps
• SerializedEllipseProps
• SerializedRectProps
• SerializedPathProps
• SerializedPolylineProps
• SerializedTextProps
• SerializedGroupProps
• SerializedImageProps

Properties

angle

angle: TDegree

Angle of rotation of an object (in degrees)

Default

0

Inherited from

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

Defined in

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

---

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’

Defined in

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

---

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

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

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

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

BaseProps.flipY

Defined in

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

---

globalCompositeOperation

globalCompositeOperation: GlobalCompositeOperation

Composite rule used for canvas globalCompositeOperation

Default

Defined in

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

---

height

height: number

Object height

Default

Inherited from

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

BaseProps.left

Defined in

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

---

opacity

opacity: number

Opacity of an object

Default

1

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'

Deprecated

please set your default to ‘center’ in new projects and don’t use it to build logic The reason is explained here: https://github.com/fabricjs/fabric.js/discussions/9736 To set the default value to ‘center’ import BaseFabricObject and set the static BaseFabricObject.ownDefaults.originX = ‘center’

Inherited from

BaseProps.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'

Deprecated

please set your default to ‘center’ in new projects and don’t use it to build logic The reason is explained here: https://github.com/fabricjs/fabric.js/discussions/9736 To set the default value to ‘center’ import BaseFabricObject and set the static BaseFabricObject.ownDefaults.originY = ‘center’

Inherited from

BaseProps.originY

Defined in

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

---

paintFirst

paintFirst: "fill" | "stroke"

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

Default

Inherited from

FillStrokeProps.paintFirst

Defined in

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

---

scaleX

scaleX: number

Object scale factor (horizontal)

Default

1

Inherited from

BaseProps.scaleX

Defined in

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

---

scaleY

scaleY: number

Object scale factor (vertical)

Default

1

Inherited from

BaseProps.scaleY

Defined in

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

---

shadow

shadow: null | Partial<SerializedShadowOptions>

Shadow object representing shadow of this shape

Default

null

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

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

BaseProps.skewY

Defined in

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

---

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

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

FillStrokeProps.strokeDashArray

Defined in

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

---

strokeDashOffset

strokeDashOffset: number

Line offset of an object’s stroke

Default

0

Inherited from

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

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

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

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

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

FillStrokeProps.strokeWidth

Defined in

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

---

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

BaseProps.top

Defined in

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

---

visible

visible: boolean

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

Default

Defined in

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

---

width

width: number

Object width

Default

Inherited from

BaseProps.width

Defined in

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