Interface EllipseProps

Hierarchy

Implemented by

Properties

absolutePositioned: boolean

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
activeOn: "down" | "up"

When 'down', object is set to active on mousedown/touchstart When 'up', object is set to active on mouseup/touchend Experimental. Let's see if this breaks anything before supporting officially

since 4.4.0

Default

'down'
angle: TDegree

Angle of rotation of an object (in degrees)

Default

0
backgroundColor: string

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

Default


borderColor: string

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

Default

rgb(178,204,255)
borderDashArray: null | number[]

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

Since

1.6.2

borderOpacityWhenMoving: number

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

Default

0.4
borderScaleFactor: number

Scale factor of object's controlling borders bigger number will make a thicker border border is 1, so this is basically a border thickness since there is no way to change the border itself.

Default

1
centeredRotation: boolean

When true, this object will use center point as the origin of transformation when being rotated via the controls. Backwards incompatibility note: This property replaces "centerTransform" (Boolean).

Since

1.3.4

Default


centeredScaling: boolean

When true, this object will use center point as the origin of transformation when being scaled via the controls. Backwards incompatibility note: This property replaces "centerTransform" (Boolean).

Since

1.3.4

Default


clipPath?: FabricObject<Partial<ObjectProps>, SerializedObjectProps, ObjectEvents>
cornerColor: string

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

Default

rgb(178,204,255)
cornerDashArray: null | number[]

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

Since

1.6.2

cornerSize: number

Size of object's controlling corners (in pixels)

Default

13
cornerStrokeColor: string

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

Since

1.6.2

Default

null
cornerStyle: "circle" | "rect"

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

Deprecated

evented: boolean

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: boolean

When true, object is not exported in OBJECT/JSON

Since

1.6.3

Default


fill: null | string | TFiller
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
flipX: boolean

When true, an object is rendered as flipped horizontally

Default

false
flipY: boolean

When true, an object is rendered as flipped vertically

Default

false
globalCompositeOperation: GlobalCompositeOperation

Composite rule used for canvas globalCompositeOperation

Default


hasBorders: boolean

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

Default


hasControls: boolean

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

Default


height: number

Object height

Default


hoverCursor: null | string

Default cursor value used when hovering over this object on canvas

Default

null
includeDefaultValues: boolean

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

Default


inverted: boolean

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
left: number

Left position of an object. Note that by default it's relative to object left. You can change this by setting originX={left/center/right}

Default

0
lockMovementX: boolean

When true, object horizontal movement is locked

Default


lockMovementY: boolean

When true, object vertical movement is locked

Default


lockRotation: boolean

When true, object rotation is locked

Default


lockScalingFlip: boolean

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

Default


lockScalingX: boolean

When true, object horizontal scaling is locked

Default


lockScalingY: boolean

When true, object vertical scaling is locked

Default


lockSkewingX: boolean

When true, object horizontal skewing is locked

Default


lockSkewingY: boolean

When true, object vertical skewing is locked

Default


minScaleLimit: number

Minimum allowed scale value of an object

Default

0
moveCursor: null | string

Default cursor value used when moving this object on canvas

Default

null
noScaleCache?: boolean

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: boolean

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
opacity: number

Opacity of an object

Default

1
originX: TOriginX

Horizontal origin of transformation of an object (one of "left", "right", "center") See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups

Default

'left'
originY: TOriginY

Vertical origin of transformation of an object (one of "top", "bottom", "center") See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups

Default

'top'
padding: number

Padding between object and its controlling borders (in pixels)

Default

0
paintFirst: "fill" | "stroke"

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

Default


perPixelTargetFind: boolean

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

Default


rx: number
ry: number
scaleX: number

Object scale factor (horizontal)

Default

1
scaleY: number

Object scale factor (vertical)

Default

1
selectable: boolean

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: string

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

Deprecated

Default


shadow: null | Shadow
skewX: number

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

Default

0
skewY: number

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

Default

0
snapAngle?: TDegree

The angle that an object will lock to while rotating.

snapThreshold?: TDegree

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

stroke: null | string | TFiller
strokeDashArray: null | number[]

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

Default

null;
strokeDashOffset: number

Line offset of an object's stroke

Default

0
strokeLineCap: CanvasLineCap

Line endings style of an object's stroke (one of "butt", "round", "square")

Default

butt
strokeLineJoin: CanvasLineJoin

Corner style of an object's stroke (one of "bevel", "round", "miter")

Default


strokeMiterLimit: number

Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke

Default

4
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
strokeWidth: number

Width of a stroke used to render this object

Default

1
top: number

Top position of an object. Note that by default it's relative to object top. You can change this by setting originY={top/center/bottom}

Default

0
touchCornerSize: number

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

Default

24
transparentCorners: boolean

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

Default

true
visible: boolean

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

Default


width: number

Object width

Default


Generated using TypeDoc