Skip to content

CanvasEvents

Defined in: src/EventTypeDefs.ts:343

after:render: object

Defined in: src/EventTypeDefs.ts:338

ctx: CanvasRenderingContext2D

StaticCanvasEvents.after:render


before:path:created: object

Defined in: src/EventTypeDefs.ts:351

path: FabricObject


before:render: object

Defined in: src/EventTypeDefs.ts:337

ctx: CanvasRenderingContext2D

StaticCanvasEvents.before:render


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

Defined in: src/EventTypeDefs.ts:241

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

CanvasSelectionEvents.before:selection:cleared


before:transform: TEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:142

transform: Transform

CanvasModificationEvents.before:transform


canvas:cleared: never

Defined in: src/EventTypeDefs.ts:334

StaticCanvasEvents.canvas:cleared


contextmenu: SimpleEventHandler<Event>

Defined in: src/EventTypeDefs.ts:308

MiscEvents.contextmenu


contextmenu:before: SimpleEventHandler<Event>

Defined in: src/EventTypeDefs.ts:307

MiscEvents.contextmenu:before


drag: DragEventData

Defined in: src/EventTypeDefs.ts:218

CanvasDnDEvents.drag


drag:enter: DragEventData & InEvent

Defined in: src/EventTypeDefs.ts:229

CanvasDnDEvents.drag:enter


drag:leave: DragEventData & OutEvent

Defined in: src/EventTypeDefs.ts:230

CanvasDnDEvents.drag:leave


dragend: DragEventData

Defined in: src/EventTypeDefs.ts:222

CanvasDnDEvents.dragend


dragenter: DragEventData & InEvent

Defined in: src/EventTypeDefs.ts:220

CanvasDnDEvents.dragenter


dragleave: DragEventData & OutEvent

Defined in: src/EventTypeDefs.ts:221

CanvasDnDEvents.dragleave


dragover: DragEventData

Defined in: src/EventTypeDefs.ts:219

CanvasDnDEvents.dragover


dragstart: TEventWithTarget<DragEvent>

Defined in: src/EventTypeDefs.ts:217

CanvasDnDEvents.dragstart


drop: DropEventData

Defined in: src/EventTypeDefs.ts:224

CanvasDnDEvents.drop


drop:after: DropEventData

Defined in: src/EventTypeDefs.ts:225

CanvasDnDEvents.drop:after


drop:before: DropEventData

Defined in: src/EventTypeDefs.ts:223

CanvasDnDEvents.drop:before


erasing:end: object

Defined in: src/EventTypeDefs.ts:356

drawables: object

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

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

path: FabricObject

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

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


erasing:start: never

Defined in: src/EventTypeDefs.ts:355


mouse:dblclick: TPointerEventInfo<TPointerEvent>

CanvasPointerEvents.mouse:dblclick


mouse:down: TPointerEventInfo<TPointerEvent> & TPointerEventInfo<TPointerEvent> & object

alreadySelected: boolean

Indicates if the target or current target where already selected before the cycle of mouse down -> mouse up started

CanvasPointerEvents.mouse:down


mouse:down:before: TPointerEventInfo<TPointerEvent>

CanvasPointerEvents.mouse:down:before


mouse:move: TPointerEventInfo<TPointerEvent>

CanvasPointerEvents.mouse:move


mouse:move:before: TPointerEventInfo<TPointerEvent>

CanvasPointerEvents.mouse:move:before


mouse:out: TPointerEventInfo<TPointerEvent> & OutEvent

CanvasPointerEvents.mouse:out


mouse:over: TPointerEventInfo<TPointerEvent> & InEvent

CanvasPointerEvents.mouse:over


mouse:tripleclick: TPointerEventInfo<TPointerEvent>

CanvasPointerEvents.mouse:tripleclick


mouse:up: TPointerEventInfo<TPointerEvent> & object

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

The subtargets at the moment of mouseup that could be different from the target at the moment of mouse down in case of a drag action for example

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

The targets at the moment of mouseup that could be different from the target at the moment of mouse down in case of a drag action for example

isClick: boolean

CanvasPointerEvents.mouse:up


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

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

The subtargets at the moment of mouseup that could be different from the target at the moment of mouse down in case of a drag action for example

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

The targets at the moment of mouseup that could be different from the target at the moment of mouse down in case of a drag action for example

isClick: boolean

CanvasPointerEvents.mouse:up:before


mouse:wheel: TPointerEventInfo<WheelEvent>

CanvasPointerEvents.mouse:wheel


object:added: object

Defined in: src/EventTypeDefs.ts:250

target: FabricObject

StaticCanvasEvents.object:added


object:layout:after: LayoutAfterEvent & object

Defined in: src/EventTypeDefs.ts:340

target: Group

StaticCanvasEvents.object:layout:after


object:layout:before: LayoutBeforeEvent & object

Defined in: src/EventTypeDefs.ts:339

target: Group

StaticCanvasEvents.object:layout:before


object:modified: ModifiedEvent

Defined in: src/EventTypeDefs.ts:152

CanvasModificationEvents.object:modified


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

Defined in: src/EventTypeDefs.ts:149

target: FabricObject

CanvasModificationEvents.object:modifyPath


object:modifyPoly: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:148

target: FabricObject

CanvasModificationEvents.object:modifyPoly


object:moving: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:143

target: FabricObject

CanvasModificationEvents.object:moving


object:removed: object

Defined in: src/EventTypeDefs.ts:251

target: FabricObject

StaticCanvasEvents.object:removed


object:resizing: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:147

target: FabricObject

CanvasModificationEvents.object:resizing


object:rotating: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:145

target: FabricObject

CanvasModificationEvents.object:rotating


object:scaling: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:144

target: FabricObject

CanvasModificationEvents.object:scaling


object:skewing: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:146

target: FabricObject

CanvasModificationEvents.object:skewing


path:created: object

Defined in: src/EventTypeDefs.ts:352

path: FabricObject


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

Defined in: src/EventTypeDefs.ts:244

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

CanvasSelectionEvents.selection:cleared


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

Defined in: src/EventTypeDefs.ts:234

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

CanvasSelectionEvents.selection:created


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

Defined in: src/EventTypeDefs.ts:237

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

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

CanvasSelectionEvents.selection:updated


text:changed: object

Defined in: src/EventTypeDefs.ts:370

target: IText


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

Defined in: src/EventTypeDefs.ts:371

target: IText


text:editing:exited: object

Defined in: src/EventTypeDefs.ts:372

target: IText


text:selection:changed: object

Defined in: src/EventTypeDefs.ts:369

target: IText