FabricObjectProps

Defined in: src/shapes/Object/types/FabricObjectProps.ts:6

Extends

ObjectProps.ControlProps.BorderProps.LockInteractionProps

Extended by

Properties

absolutePositioned

absolutePositioned: boolean

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

Meaningful ONLY when the object is used as clipPath. if true, the clipPath will have its top and left relative to canvas, and will not be influenced by the object transform. This will make the clipPath relative to the canvas, but clipping just a particular object. WARNING this is beta, this feature may change or be renamed. since 2.4.0

Default

false

Inherited from

ObjectProps.absolutePositioned

angle

angle: TDegree

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

Angle of rotation of an object (in degrees)

Default

Inherited from

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

Inherited from

ObjectProps.backgroundColor

borderColor

borderColor: string

Defined in: src/shapes/Object/types/BorderProps.ts:7

Color of controlling borders of an object (when it’s active)

Default

rgb(178,204,255)

Inherited from

BorderProps.borderColor

borderDashArray

borderDashArray: null | number[]

Defined in: src/shapes/Object/types/BorderProps.ts:15

Array specifying dash pattern of an object’s borders (hasBorder must be true)

Since

1.6.2

Inherited from

BorderProps.borderDashArray

borderOpacityWhenMoving

borderOpacityWhenMoving: number

Defined in: src/shapes/Object/types/BorderProps.ts:29

Opacity of object’s controlling borders when object is active and moving

Default

0.4

Inherited from

BorderProps.borderOpacityWhenMoving

borderScaleFactor

borderScaleFactor: number

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

Scale factor for the border of the objects ( selection box and controls stroke ). Bigger number will make a thicker border border default value is 1, so this scale value is equal to a border and control strokeWidth. Id you need to divide border from control strokeWidth you will need to write your own render function for controls

Default

Inherited from

BorderProps.borderScaleFactor

canvas?

optional canvas: Canvas | StaticCanvas

Defined in: src/shapes/Object/types/ObjectProps.ts:20

Inherited from

ObjectProps.canvas

centeredRotation

centeredRotation: boolean

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

When true the object will rotate on its center. When false will rotate around the origin point defined by originX and originY. The value of this property is IGNORED during a transform if the canvas has already centeredRotation set to true The object method rotate will always consider this property and never the canvas’s one.

Since

1.3.4

Default

Inherited from

ObjectProps.centeredRotation

centeredScaling

centeredScaling: boolean

Defined in: src/shapes/Object/types/ObjectTransformProps.ts:36

When true, this object will use center point as the origin of transformation when being scaled via the controls.

Since

1.3.4

Default

Inherited from

ObjectProps.centeredScaling

clipPath?

optional clipPath: BaseFabricObject

Defined in: src/shapes/Object/types/ObjectProps.ts:16

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

ObjectProps.clipPath

cornerColor

cornerColor: string

Defined in: src/shapes/Object/types/ControlProps.ts:28

Color of controlling corners of an object (when it’s active)

Default

rgb(178,204,255)

Inherited from

ControlProps.cornerColor

cornerDashArray

cornerDashArray: null | number[]

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

Array specifying dash pattern of an object’s control (hasBorder must be true)

Since

1.6.2

Default

null

Inherited from

ControlProps.cornerDashArray

cornerSize

cornerSize: number

Defined in: src/shapes/Object/types/ControlProps.ts:7

Size of object’s controlling corners (in pixels)

Default

Inherited from

ControlProps.cornerSize

cornerStrokeColor

cornerStrokeColor: string

Defined in: src/shapes/Object/types/ControlProps.ts:36

Color of controlling corners of an object (when it’s active and transparentCorners false)

Since

1.6.2

Default

''

Inherited from

ControlProps.cornerStrokeColor

cornerStyle

cornerStyle: "circle" | "rect"

Defined in: src/shapes/Object/types/ControlProps.ts:47

Specify style of control, ‘rect’ or ‘circle’ This is deprecated. In the future there will be a standard control render And you can swap it with one of the alternative proposed with the control api

Since

1.6.2

Default

'rect'

Inherited from

ControlProps.cornerStyle

evented

evented: boolean

Defined in: src/shapes/Object/types/FabricObjectProps.ts:65

When set to false, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4

Default

excludeFromExport

excludeFromExport: boolean

Defined in: src/shapes/Object/types/ObjectProps.ts:52

When true, object is not exported in OBJECT/JSON

Since

1.6.3

Default

Inherited from

ObjectProps.excludeFromExport

fill

fill: null | string | TFiller

Defined in: src/shapes/Object/types/ObjectProps.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

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

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

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

ObjectProps.flipY

globalCompositeOperation

globalCompositeOperation: GlobalCompositeOperation

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

Composite rule used for canvas globalCompositeOperation

Default

Inherited from

ObjectProps.globalCompositeOperation

hasBorders

hasBorders: boolean

Defined in: src/shapes/Object/types/BorderProps.ts:22

When set to false, object’s controlling borders are not rendered

Default

Inherited from

BorderProps.hasBorders

hasControls

hasControls: boolean

Defined in: src/shapes/Object/types/ControlProps.ts:69

When set to false, object’s controls are not displayed and can not be used to manipulate object

Default

true

Inherited from

ControlProps.hasControls

height

height: number

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

Object height

Default

Inherited from

ObjectProps.height

hoverCursor

hoverCursor: null | string

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

Default cursor value used when hovering over this object on canvas

Default

null

includeDefaultValues

includeDefaultValues: boolean

Defined in: src/shapes/Object/types/ObjectProps.ts:44

When false, default object’s values are not included in its serialization

Default

Inherited from

ObjectProps.includeDefaultValues

inverted

inverted: boolean

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

Meaningful ONLY when the object is used as clipPath. if true, the clipPath will make the object clip to the outside of the clipPath since 2.4.0

Default

false

Inherited from

ObjectProps.inverted

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

Inherited from

ObjectProps.left

lockMovementX

lockMovementX: boolean

Defined in: src/shapes/Object/types/LockInteractionProps.ts:7

When true, object horizontal movement is locked

Default

Inherited from

LockInteractionProps.lockMovementX

lockMovementY

lockMovementY: boolean

Defined in: src/shapes/Object/types/LockInteractionProps.ts:14

When true, object vertical movement is locked

Default

Inherited from

LockInteractionProps.lockMovementY

lockRotation

lockRotation: boolean

Defined in: src/shapes/Object/types/LockInteractionProps.ts:21

When true, object rotation is locked

Default

Inherited from

LockInteractionProps.lockRotation

lockScalingFlip

lockScalingFlip: boolean

Defined in: src/shapes/Object/types/LockInteractionProps.ts:56

When true, object cannot be flipped by scaling into negative values

Default

Inherited from

LockInteractionProps.lockScalingFlip

lockScalingX

lockScalingX: boolean

Defined in: src/shapes/Object/types/LockInteractionProps.ts:28

When true, object horizontal scaling is locked

Default

Inherited from

LockInteractionProps.lockScalingX

lockScalingY

lockScalingY: boolean

Defined in: src/shapes/Object/types/LockInteractionProps.ts:35

When true, object vertical scaling is locked

Default

Inherited from

LockInteractionProps.lockScalingY

lockSkewingX

lockSkewingX: boolean

Defined in: src/shapes/Object/types/LockInteractionProps.ts:42

When true, object horizontal skewing is locked

Default

Inherited from

LockInteractionProps.lockSkewingX

lockSkewingY

lockSkewingY: boolean

Defined in: src/shapes/Object/types/LockInteractionProps.ts:49

When true, object vertical skewing is locked

Default

Inherited from

LockInteractionProps.lockSkewingY

minScaleLimit

minScaleLimit: number

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

Minimum allowed scale value of an object

Default

Inherited from

ObjectProps.minScaleLimit

moveCursor

moveCursor: null | string

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

Default cursor value used when moving this object on canvas

Default

null

noScaleCache?

optional noScaleCache: boolean

Defined in: src/shapes/Object/types/FabricObjectProps.ts:20

When true, cache does not get updated during scaling. The picture will get blocky if scaled too much and will be redrawn with correct details at the end of scaling. this setting is performance and application dependant. default to true since 1.7.0

Default

true

objectCaching

objectCaching: boolean

Defined in: src/shapes/Object/types/ObjectProps.ts:37

When true, object is cached on an additional canvas. When false, object is not cached unless necessary ( clipPath ) default to true

Since

1.7.0

Default

true

Inherited from

ObjectProps.objectCaching

opacity

opacity: number

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

Opacity of an object

Default

Inherited from

ObjectProps.opacity

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

'left'

Inherited from

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

Default

'top'

Inherited from

ObjectProps.originY

padding

padding: number

Defined in: src/shapes/Object/types/ControlProps.ts:62

Padding between object and its controlling borders (in pixels)

Default

Inherited from

ControlProps.padding

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

ObjectProps.paintFirst

perPixelTargetFind

perPixelTargetFind: boolean

Defined in: src/shapes/Object/types/FabricObjectProps.ts:50

When set to true, objects are “found” on canvas on per-pixel basis rather than according to bounding box

Default

scaleX

scaleX: number

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

Object scale factor (horizontal)

Default

Inherited from

ObjectProps.scaleX

scaleY

scaleY: number

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

Object scale factor (vertical)

Default

Inherited from

ObjectProps.scaleY

selectable

selectable: boolean

Defined in: src/shapes/Object/types/FabricObjectProps.ts:58

When set to false, an object can not be selected for modification (using either point-click-based or group-based selection). But events still fire on it.

Default

selectionBackgroundColor

selectionBackgroundColor: string

Defined in: src/shapes/Object/types/FabricObjectProps.ts:43

Selection Background color of an object. colored layer behind the object when it is active. does not mix good with globalCompositeOperation methods.

Default

shadow

shadow: null | Shadow

Defined in: src/shapes/Object/types/ObjectProps.ts:19

Shadow object representing shadow of this shape

Default

null

Inherited from

ObjectProps.shadow

skewX

skewX: TDegree

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

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

Default

Inherited from

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

Inherited from

ObjectProps.skewY

snapAngle?

optional snapAngle: TDegree

Defined in: src/shapes/Object/types/ObjectTransformProps.ts:8

The angle that an object will lock to while rotating.

Inherited from

ObjectProps.snapAngle

snapThreshold?

optional snapThreshold: TDegree

Defined in: src/shapes/Object/types/ObjectTransformProps.ts:15

The angle difference from the current snapped angle in which snapping should occur. When undefined, the snapThreshold will default to the snapAngle.

Inherited from

ObjectProps.snapThreshold

stroke

stroke: null | string | TFiller

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

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

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

ObjectProps.strokeDashArray

strokeDashOffset

strokeDashOffset: number

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

Line offset of an object’s stroke

Default

Inherited from

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

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

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

Inherited from

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

ObjectProps.strokeUniform

strokeWidth

strokeWidth: number

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

Width of a stroke used to render this object

Default

Inherited from

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

Inherited from

ObjectProps.top

touchCornerSize

touchCornerSize: number

Defined in: src/shapes/Object/types/ControlProps.ts:14

Size of object’s controlling corners when touch interaction is detected

Default

Inherited from

ControlProps.touchCornerSize

transparentCorners

transparentCorners: boolean

Defined in: src/shapes/Object/types/ControlProps.ts:21

When true, object’s controlling corners are rendered as transparent inside (i.e. stroke instead of fill)

Default

true

Inherited from

ControlProps.transparentCorners

visible

visible: boolean

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

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

Default

Inherited from

ObjectProps.visible

width

width: number

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

Object width

Default

Inherited from

ObjectProps.width