Skip to content

CanvasEvents

Extends

Properties

after:render

after:render: object

ctx

ctx: CanvasRenderingContext2D

Inherited from

StaticCanvasEvents.after:render

Defined in

src/EventTypeDefs.ts:318


before:path:created

before:path:created: object

path

path: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Defined in

src/EventTypeDefs.ts:331


before:render

before:render: object

ctx

ctx: CanvasRenderingContext2D

Inherited from

StaticCanvasEvents.before:render

Defined in

src/EventTypeDefs.ts:317


before:selection:cleared

before:selection:cleared: Partial<TEvent<TPointerEvent>> & object

Type declaration

deselected

deselected: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Inherited from

CanvasSelectionEvents.before:selection:cleared

Defined in

src/EventTypeDefs.ts:241


before:transform

before:transform: TEvent<TPointerEvent> & object

Type declaration

transform

transform: Transform

Inherited from

CanvasModificationEvents.before:transform

Defined in

src/EventTypeDefs.ts:142


canvas:cleared

canvas:cleared: never

Inherited from

StaticCanvasEvents.canvas:cleared

Defined in

src/EventTypeDefs.ts:314


contextmenu

contextmenu: SimpleEventHandler<Event>

Inherited from

MiscEvents.contextmenu

Defined in

src/EventTypeDefs.ts:288


contextmenu:before

contextmenu:before: SimpleEventHandler<Event>

Inherited from

MiscEvents.contextmenu:before

Defined in

src/EventTypeDefs.ts:287


drag

drag: DragEventData

Inherited from

CanvasDnDEvents.drag

Defined in

src/EventTypeDefs.ts:218


drag:enter

drag:enter: DragEventData & InEvent

Inherited from

CanvasDnDEvents.drag:enter

Defined in

src/EventTypeDefs.ts:229


drag:leave

drag:leave: DragEventData & OutEvent

Inherited from

CanvasDnDEvents.drag:leave

Defined in

src/EventTypeDefs.ts:230


dragend

dragend: DragEventData

Inherited from

CanvasDnDEvents.dragend

Defined in

src/EventTypeDefs.ts:222


dragenter

dragenter: DragEventData & InEvent

Inherited from

CanvasDnDEvents.dragenter

Defined in

src/EventTypeDefs.ts:220


dragleave

dragleave: DragEventData & OutEvent

Inherited from

CanvasDnDEvents.dragleave

Defined in

src/EventTypeDefs.ts:221


dragover

dragover: DragEventData

Inherited from

CanvasDnDEvents.dragover

Defined in

src/EventTypeDefs.ts:219


dragstart

dragstart: TEventWithTarget<DragEvent>

Inherited from

CanvasDnDEvents.dragstart

Defined in

src/EventTypeDefs.ts:217


drop

drop: DropEventData

Inherited from

CanvasDnDEvents.drop

Defined in

src/EventTypeDefs.ts:224


drop:after

drop:after: DropEventData

Inherited from

CanvasDnDEvents.drop:after

Defined in

src/EventTypeDefs.ts:225


drop:before

drop:before: DropEventData

Inherited from

CanvasDnDEvents.drop:before

Defined in

src/EventTypeDefs.ts:223


erasing:end

erasing:end: object

drawables

drawables: object

drawables.backgroundImage?

optional backgroundImage: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

drawables.overlayImage?

optional overlayImage: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

path

path: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

subTargets

subTargets: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

targets

targets: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Defined in

src/EventTypeDefs.ts:336


erasing:start

erasing:start: never

Defined in

src/EventTypeDefs.ts:335


mouse:dblclick

mouse:dblclick: TPointerEventInfo<TPointerEvent>

Inherited from

CanvasPointerEvents.mouse:dblclick


mouse:down

mouse:down: TPointerEventInfo<TPointerEvent>

Inherited from

CanvasPointerEvents.mouse:down


mouse:down:before

mouse:down:before: TPointerEventInfo<TPointerEvent>

Inherited from

CanvasPointerEvents.mouse:down:before


mouse:move

mouse:move: TPointerEventInfo<TPointerEvent>

Inherited from

CanvasPointerEvents.mouse:move


mouse:move:before

mouse:move:before: TPointerEventInfo<TPointerEvent>

Inherited from

CanvasPointerEvents.mouse:move:before


mouse:out

mouse:out: TPointerEventInfo<TPointerEvent> & OutEvent

Inherited from

CanvasPointerEvents.mouse:out


mouse:over

mouse:over: TPointerEventInfo<TPointerEvent> & InEvent

Inherited from

CanvasPointerEvents.mouse:over


mouse:up

mouse:up: TPointerEventInfo<TPointerEvent> & object

Type declaration

currentSubTargets

currentSubTargets: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

currentTarget?

optional currentTarget: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

isClick

isClick: boolean

Inherited from

CanvasPointerEvents.mouse:up


mouse:up:before

mouse:up:before: TPointerEventInfo<TPointerEvent> & object

Type declaration

currentSubTargets

currentSubTargets: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

currentTarget?

optional currentTarget: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

isClick

isClick: boolean

Inherited from

CanvasPointerEvents.mouse:up:before


mouse:wheel

mouse:wheel: TPointerEventInfo<WheelEvent>

Inherited from

CanvasPointerEvents.mouse:wheel


object:added

object:added: object

target

target: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Inherited from

StaticCanvasEvents.object:added

Defined in

src/EventTypeDefs.ts:250


object:layout:after

object:layout:after: LayoutAfterEvent & object

Type declaration

target

target: Group

Inherited from

StaticCanvasEvents.object:layout:after

Defined in

src/EventTypeDefs.ts:320


object:layout:before

object:layout:before: LayoutBeforeEvent & object

Type declaration

target

target: Group

Inherited from

StaticCanvasEvents.object:layout:before

Defined in

src/EventTypeDefs.ts:319


object:modified

object:modified: ModifiedEvent<TPointerEvent>

Inherited from

CanvasModificationEvents.object:modified

Defined in

src/EventTypeDefs.ts:152


object:modifyPath

object:modifyPath: BasicTransformEvent<TPointerEvent> & object & ModifyPathEvent

Type declaration

target

target: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Inherited from

CanvasModificationEvents.object:modifyPath

Defined in

src/EventTypeDefs.ts:149


object:modifyPoly

object:modifyPoly: BasicTransformEvent<TPointerEvent> & object

Type declaration

target

target: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Inherited from

CanvasModificationEvents.object:modifyPoly

Defined in

src/EventTypeDefs.ts:148


object:moving

object:moving: BasicTransformEvent<TPointerEvent> & object

Type declaration

target

target: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Inherited from

CanvasModificationEvents.object:moving

Defined in

src/EventTypeDefs.ts:143


object:removed

object:removed: object

target

target: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Inherited from

StaticCanvasEvents.object:removed

Defined in

src/EventTypeDefs.ts:251


object:resizing

object:resizing: BasicTransformEvent<TPointerEvent> & object

Type declaration

target

target: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Inherited from

CanvasModificationEvents.object:resizing

Defined in

src/EventTypeDefs.ts:147


object:rotating

object:rotating: BasicTransformEvent<TPointerEvent> & object

Type declaration

target

target: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Inherited from

CanvasModificationEvents.object:rotating

Defined in

src/EventTypeDefs.ts:145


object:scaling

object:scaling: BasicTransformEvent<TPointerEvent> & object

Type declaration

target

target: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Inherited from

CanvasModificationEvents.object:scaling

Defined in

src/EventTypeDefs.ts:144


object:skewing

object:skewing: BasicTransformEvent<TPointerEvent> & object

Type declaration

target

target: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Inherited from

CanvasModificationEvents.object:skewing

Defined in

src/EventTypeDefs.ts:146


path:created

path:created: object

path

path: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Defined in

src/EventTypeDefs.ts:332


selection:cleared

selection:cleared: Partial<TEvent<TPointerEvent>> & object

Type declaration

deselected

deselected: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Inherited from

CanvasSelectionEvents.selection:cleared

Defined in

src/EventTypeDefs.ts:244


selection:created

selection:created: Partial<TEvent<TPointerEvent>> & object

Type declaration

selected

selected: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Inherited from

CanvasSelectionEvents.selection:created

Defined in

src/EventTypeDefs.ts:234


selection:updated

selection:updated: Partial<TEvent<TPointerEvent>> & object

Type declaration

deselected

deselected: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

selected

selected: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Inherited from

CanvasSelectionEvents.selection:updated

Defined in

src/EventTypeDefs.ts:237


text:changed

text:changed: object

target

target: IText<Partial<ITextProps>, SerializedITextProps, ITextEvents>

Defined in

src/EventTypeDefs.ts:350


text:editing:entered

text:editing:entered: object & Partial<TEvent<TPointerEvent>>

Type declaration

target

target: IText<Partial<ITextProps>, SerializedITextProps, ITextEvents>

Defined in

src/EventTypeDefs.ts:351


text:editing:exited

text:editing:exited: object

target

target: IText<Partial<ITextProps>, SerializedITextProps, ITextEvents>

Defined in

src/EventTypeDefs.ts:352


text:selection:changed

text:selection:changed: object

target

target: IText<Partial<ITextProps>, SerializedITextProps, ITextEvents>

Defined in

src/EventTypeDefs.ts:349