CanvasEvents

Defined in: src/EventTypeDefs.ts:343

Extends

• StaticCanvasEvents.CanvasPointerEvents.CanvasDnDEvents.MiscEvents.CanvasModificationEvents.CanvasSelectionEvents

Properties

after:render

after:render: object

Defined in: src/EventTypeDefs.ts:338

ctx

ctx: CanvasRenderingContext2D

Inherited from

StaticCanvasEvents.after:render

---

before:path:created

before:path:created: object

Defined in: src/EventTypeDefs.ts:351

path

path: FabricObject

---

before:render

before:render: object

Defined in: src/EventTypeDefs.ts:337

ctx

ctx: CanvasRenderingContext2D

Inherited from

StaticCanvasEvents.before:render

---

before:selection:cleared

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

Defined in: src/EventTypeDefs.ts:241

Type declaration

deselected

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

Inherited from

CanvasSelectionEvents.before:selection:cleared

---

before:transform

before:transform: TEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:142

Type declaration

transform

transform: Transform

Inherited from

CanvasModificationEvents.before:transform

---

canvas:cleared

canvas:cleared: never

Defined in: src/EventTypeDefs.ts:334

Inherited from

StaticCanvasEvents.canvas:cleared

---

contextmenu

contextmenu: SimpleEventHandler<Event>

Defined in: src/EventTypeDefs.ts:308

Inherited from

MiscEvents.contextmenu

---

contextmenu:before

contextmenu:before: SimpleEventHandler<Event>

Defined in: src/EventTypeDefs.ts:307

Inherited from

MiscEvents.contextmenu:before

---

drag

drag: DragEventData

Defined in: src/EventTypeDefs.ts:218

Inherited from

CanvasDnDEvents.drag

---

drag:enter

drag:enter: DragEventData & InEvent

Defined in: src/EventTypeDefs.ts:229

Inherited from

CanvasDnDEvents.drag:enter

---

drag:leave

drag:leave: DragEventData & OutEvent

Defined in: src/EventTypeDefs.ts:230

Inherited from

CanvasDnDEvents.drag:leave

---

dragend

dragend: DragEventData

Defined in: src/EventTypeDefs.ts:222

Inherited from

CanvasDnDEvents.dragend

---

dragenter

dragenter: DragEventData & InEvent

Defined in: src/EventTypeDefs.ts:220

Inherited from

CanvasDnDEvents.dragenter

---

dragleave

dragleave: DragEventData & OutEvent

Defined in: src/EventTypeDefs.ts:221

Inherited from

CanvasDnDEvents.dragleave

---

dragover

dragover: DragEventData

Defined in: src/EventTypeDefs.ts:219

Inherited from

CanvasDnDEvents.dragover

---

dragstart

dragstart: TEventWithTarget<DragEvent>

Defined in: src/EventTypeDefs.ts:217

Inherited from

CanvasDnDEvents.dragstart

---

drop

drop: DropEventData

Defined in: src/EventTypeDefs.ts:224

Inherited from

CanvasDnDEvents.drop

---

drop:after

drop:after: DropEventData

Defined in: src/EventTypeDefs.ts:225

Inherited from

CanvasDnDEvents.drop:after

---

drop:before

drop:before: DropEventData

Defined in: src/EventTypeDefs.ts:223

Inherited from

CanvasDnDEvents.drop:before

---

erasing:end

erasing:end: object

Defined in: src/EventTypeDefs.ts:356

drawables

drawables: object

drawables.backgroundImage?

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

drawables.overlayImage?

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

path

path: FabricObject

subTargets

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

targets

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

---

erasing:start

erasing:start: never

Defined in: src/EventTypeDefs.ts:355

---

mouse:dblclick

mouse:dblclick: TPointerEventInfo<TPointerEvent>

Inherited from

CanvasPointerEvents.mouse:dblclick

---

mouse:down

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

Type declaration

alreadySelected

alreadySelected: boolean

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

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

mouse:tripleclick: TPointerEventInfo<TPointerEvent>

Inherited from

CanvasPointerEvents.mouse:tripleclick

---

mouse:up

mouse:up: TPointerEventInfo<TPointerEvent> & object

Type declaration

currentSubTargets

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

currentTarget?

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

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>[]

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

currentTarget?

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

isClick: boolean

Inherited from

CanvasPointerEvents.mouse:up:before

---

mouse:wheel

mouse:wheel: TPointerEventInfo<WheelEvent>

Inherited from

CanvasPointerEvents.mouse:wheel

---

object:added

object:added: object

Defined in: src/EventTypeDefs.ts:250

target

target: FabricObject

Inherited from

StaticCanvasEvents.object:added

---

object:layout:after

object:layout:after: LayoutAfterEvent & object

Defined in: src/EventTypeDefs.ts:340

Type declaration

target

target: Group

Inherited from

StaticCanvasEvents.object:layout:after

---

object:layout:before

object:layout:before: LayoutBeforeEvent & object

Defined in: src/EventTypeDefs.ts:339

Type declaration

target

target: Group

Inherited from

StaticCanvasEvents.object:layout:before

---

object:modified

object:modified: ModifiedEvent

Defined in: src/EventTypeDefs.ts:152

Inherited from

CanvasModificationEvents.object:modified

---

object:modifyPath

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

Defined in: src/EventTypeDefs.ts:149

Type declaration

target

target: FabricObject

Inherited from

CanvasModificationEvents.object:modifyPath

---

object:modifyPoly

object:modifyPoly: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:148

Type declaration

target

target: FabricObject

Inherited from

CanvasModificationEvents.object:modifyPoly

---

object:moving

object:moving: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:143

Type declaration

target

target: FabricObject

Inherited from

CanvasModificationEvents.object:moving

---

object:removed

object:removed: object

Defined in: src/EventTypeDefs.ts:251

target

target: FabricObject

Inherited from

StaticCanvasEvents.object:removed

---

object:resizing

object:resizing: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:147

Type declaration

target

target: FabricObject

Inherited from

CanvasModificationEvents.object:resizing

---

object:rotating

object:rotating: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:145

Type declaration

target

target: FabricObject

Inherited from

CanvasModificationEvents.object:rotating

---

object:scaling

object:scaling: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:144

Type declaration

target

target: FabricObject

Inherited from

CanvasModificationEvents.object:scaling

---

object:skewing

object:skewing: BasicTransformEvent<TPointerEvent> & object

Defined in: src/EventTypeDefs.ts:146

Type declaration

target

target: FabricObject

Inherited from

CanvasModificationEvents.object:skewing

---

path:created

path:created: object

Defined in: src/EventTypeDefs.ts:352

path

path: FabricObject

---

selection:cleared

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

Defined in: src/EventTypeDefs.ts:244

Type declaration

deselected

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

Inherited from

CanvasSelectionEvents.selection:cleared

---

selection:created

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

Defined in: src/EventTypeDefs.ts:234

Type declaration

selected

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

Inherited from

CanvasSelectionEvents.selection:created

---

selection:updated

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

Defined in: src/EventTypeDefs.ts:237

Type declaration

deselected

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

selected

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

Inherited from

CanvasSelectionEvents.selection:updated

---

text:changed

text:changed: object

Defined in: src/EventTypeDefs.ts:370

target

target: IText

---

text:editing:entered

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

Defined in: src/EventTypeDefs.ts:371

Type declaration

target

target: IText

---

text:editing:exited

text:editing:exited: object

Defined in: src/EventTypeDefs.ts:372

target

target: IText

---

text:selection:changed

text:selection:changed: object

Defined in: src/EventTypeDefs.ts:369

target

target: IText