SerializedObjectProps

Defined in: src/shapes/Object/types/SerializedObjectProps.ts:5

Extends

• BaseProps.FillStrokeProps

Extended by

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

Properties

angle

angle: TDegree

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

Angle of rotation of an object (in degrees)

Default

0

Inherited from

BaseProps.angle

---

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

---

clipPath?

optional clipPath: 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’

---

fill

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

rgb(0,0,0)

Inherited from

FillStrokeProps.fill

---

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

nonzero

Inherited from

FillStrokeProps.fillRule

---

flipX

flipX: boolean

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

When true, an object is rendered as flipped horizontally

Default

false

Inherited from

BaseProps.flipX

---

flipY

flipY: boolean

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

When true, an object is rendered as flipped vertically

Default

false

Inherited from

BaseProps.flipY

---

globalCompositeOperation

globalCompositeOperation: GlobalCompositeOperation

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

Composite rule used for canvas globalCompositeOperation

Default

---

height

height: number

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

Object height

Default

Inherited from

BaseProps.height

---

left

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 originX

Default

0

Inherited from

BaseProps.left

---

opacity

opacity: number

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

Opacity of an object

Default

1

---

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

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’

Default

'left'

Inherited from

BaseProps.originX

---

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

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’

Default

'top'

Inherited from

BaseProps.originY

---

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

Inherited from

FillStrokeProps.paintFirst

---

scaleX

scaleX: number

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

Object scale factor (horizontal)

Default

1

Inherited from

BaseProps.scaleX

---

scaleY

scaleY: number

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

Object scale factor (vertical)

Default

1

Inherited from

BaseProps.scaleY

---

shadow

shadow: null | Partial<SerializedShadowOptions>

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

Shadow object representing shadow of this shape

Default

null

---

skewX

skewX: TDegree

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

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

Default

0

Inherited from

BaseProps.skewX

---

skewY

skewY: TDegree

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

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

Default

0

Inherited from

BaseProps.skewY

---

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

null

Inherited from

FillStrokeProps.stroke

---

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

null;

Inherited from

FillStrokeProps.strokeDashArray

---

strokeDashOffset

strokeDashOffset: number

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

Line offset of an object’s stroke

Default

0

Inherited from

FillStrokeProps.strokeDashOffset

---

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

butt

Inherited from

FillStrokeProps.strokeLineCap

---

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

Inherited from

FillStrokeProps.strokeLineJoin

---

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

4

Inherited from

FillStrokeProps.strokeMiterLimit

---

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

Since

2.6.0

Default

false

Default

false

Inherited from

FillStrokeProps.strokeUniform

---

strokeWidth

strokeWidth: number

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

Width of a stroke used to render this object

Default

1

Inherited from

FillStrokeProps.strokeWidth

---

top

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 originY

Default

0

Inherited from

BaseProps.top

---

visible

visible: boolean

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

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

Default

---

width

width: number

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

Object width

Default

Inherited from

BaseProps.width