Winter Cardinal UI - v0.457.0 / DDiagramEditorEvents

Interface: DDiagramEditorEvents<EMITTER>

DDiagramEditor events.

Type parameters

Name
EMITTER

Hierarchy

• DDiagramBaseEvents<DDiagramCanvasEditor, EMITTER>

  ↳ DDiagramEditorEvents

Table of contents

Methods

• added
• change
• click
• dblclick
• deleted
• deleting
• down
• init
• keydown
• keyup
• move
• opened
• opening
• out
• over
• ready
• removed
• resize
• saved
• saving
• scale
• serialized
• serializing
• set
• shortcut
• skew
• statechange
• unset
• up
• wheel

Methods

added

▸ added(container): void

Triggered when added to a container.

Parameters

Name	Type	Description
container	Container	a container added to

Returns

void

Inherited from

DDiagramBaseEvents.added

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:100

---

change

▸ change(emitter): void

Triggered when a serialized data is changed without using the set / unset methods. This happens, for instance, when the name or the ID of the serialized data is changed.

Parameters

Name	Type	Description
emitter	EMITTER	an emitter

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-editor.ts:43

---

click

▸ click(e, emitter): void

Triggered when an emitter is clicked.

Parameters

Name	Type	Description
e	InteractionEvent	an interaction event
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.click

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:232

---

dblclick

▸ dblclick(e, interactionManager, emitter): void

Triggered when an emitter is double clicked.

Parameters

Name	Type	Description
e	MouseEvent | TouchEvent	an event
interactionManager	InteractionManager	an interaction manager
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.dblclick

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:241

---

deleted

▸ deleted(reason, emitter): void

Triggered when deleted successfully or when failed to delete.

Parameters

Name	Type	Description
reason	null | string	Null if succeeded. Otherwise, a string representing a reason why failed.
emitter	EMITTER	an emitter.

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-editor.ts:105

---

deleting

▸ deleting(emitter): void

Triggered before deleting.

Parameters

Name	Type	Description
emitter	EMITTER	an emitter

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-editor.ts:97

---

down

▸ down(e, emitter): void

Triggered when a pointer gets down on an emitter.

Parameters

Name	Type	Description
e	InteractionEvent	an interaction event.
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.down

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:216

---

init

▸ init(emitter): void

Triggered when an initialization is finished.

Parameters

Name	Type	Description
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.init

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:93

---

keydown

▸ keydown(e, emitter): void

Triggered when a key gets down.

Parameters

Name	Type	Description
e	KeyboardEvent	a keyboard event
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.keydown

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:184

---

keyup

▸ keyup(e, emitter): void

Triggered when a key gets up.

Parameters

Name	Type	Description
e	KeyboardEvent	a keyboard event
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.keyup

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:192

---

move

▸ move(newX, newY, oldX, oldY, emitter): void

Triggered when moved.

Parameters

Name	Type	Description
newX	number	a new x
newY	number	a new y
oldX	number	an old x
oldY	number	an old y
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.move

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:118

---

opened

▸ opened(reason, emitter): void

Triggered when opened successfully or when failed to open.

Parameters

Name	Type	Description
reason	null | string	Null if succeeded. Otherwise, a string representing a reason why failed.
emitter	EMITTER	an emitter

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-editor.ts:90

---

opening

▸ opening(emitter): void

Triggered before opening.

Parameters

Name	Type	Description
emitter	EMITTER	an emitter

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-editor.ts:82

---

out

▸ out(e, emitter): void

Triggered when a pointer gets out of an emitter.

Parameters

Name	Type	Description
e	InteractionEvent	an interaction event
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.out

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:208

---

over

▸ over(e, emitter): void

Triggered when a pointer gets on an emitter.

Parameters

Name	Type	Description
e	InteractionEvent	an interaction event.
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.over

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:200

---

ready

▸ ready(emitter): void

Triggered when all the shape initializations are finished.

Parameters

Name	Type	Description
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.ready

Defined in

src/main/typescript/wcardinal/ui/d-diagram-base.ts:42

---

removed

▸ removed(container): void

Triggered when removed from a container.

Parameters

Name	Type	Description
container	Container	a container removed from

Returns

void

Inherited from

DDiagramBaseEvents.removed

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:107

---

resize

▸ resize(newWidth, newHeight, oldWidth, oldHeight, emitter): void

Triggered when resized.

Parameters

Name	Type	Description
newWidth	number	a new width
newHeight	number	a new height
oldWidth	number	an old width
oldHeight	number	an old height
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.resize

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:129

---

saved

▸ saved(reason, emitter): void

Triggered when saved successfully or when failed to save.

Parameters

Name	Type	Description
reason	null | string	Null if succeeded. Otherwise, a string representing a reason why failed.
emitter	EMITTER	an emitter

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-editor.ts:75

---

saving

▸ saving(simple, emitter): void

Triggered before saving.

Parameters

Name	Type	Description
simple	DDiagramSerializedSimple	a serialized data
emitter	EMITTER	an emitter

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-editor.ts:67

---

scale

▸ scale(newX, newY, oldX, oldY, emitter): void

Triggered when scaled.

Parameters

Name	Type	Description
newX	number	a new x
newY	number	a new y
oldX	number	an old x
oldY	number	an old y
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.scale

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:146

---

serialized

▸ serialized(canvas, reason, emitter): void

Triggered when serialized successfully or when failed to serialize.

Parameters

Name	Type	Description
canvas	DDiagramCanvasEditor<DThemeDiagramCanvasEditor, DDiagramCanvasEditorOptions<DThemeDiagramCanvasEditor>>	-
reason	null | string	Null if succeeded. Otherwise, a string representing a reason why failed.
emitter	EMITTER	an emitter

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-editor.ts:59

---

serializing

▸ serializing(canvas, emitter): void

Triggered before serializing a canvas.

Parameters

Name	Type	Description
canvas	DDiagramCanvasEditor<DThemeDiagramCanvasEditor, DDiagramCanvasEditorOptions<DThemeDiagramCanvasEditor>>	a canvas
emitter	EMITTER	an emitter

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-editor.ts:51

---

set

▸ set(canvas, emitter): void

Triggered when a canvas is set.

Parameters

Name	Type	Description
canvas	DDiagramCanvasEditor<DThemeDiagramCanvasEditor, DDiagramCanvasEditorOptions<DThemeDiagramCanvasEditor>>	a new canvas
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.set

Defined in

src/main/typescript/wcardinal/ui/d-canvas-container.ts:34

---

shortcut

▸ shortcut(e, emitter): void

Triggered when a shortcut is pressed.

Parameters

Name	Type	Description
e	KeyboardEvent	an event
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.shortcut

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:253

---

skew

▸ skew(newX, newY, oldX, oldY, emitter): void

Triggered when skewed.

Parameters

Name	Type	Description
newX	number	a new x
newY	number	a new y
oldX	number	an old x
oldY	number	an old y
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.skew

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:157

---

statechange

▸ statechange(newState, oldState, emitter): void

Triggered when a state is changed.

Parameters

Name	Type	Description
newState	DBaseStateSet	a new state
oldState	DBaseStateSet	an old state
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.statechange

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:166

---

unset

▸ unset(canvas, emitter): void

Triggered when a canvas is removed.

Parameters

Name	Type	Description
canvas	DDiagramCanvasEditor<DThemeDiagramCanvasEditor, DDiagramCanvasEditorOptions<DThemeDiagramCanvasEditor>>	a removed canvas
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.unset

Defined in

src/main/typescript/wcardinal/ui/d-canvas-container.ts:26

---

up

▸ up(e, emitter): void

Triggered when a pointer gets up on an emitter.

Parameters

Name	Type	Description
e	InteractionEvent	an interaction event
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.up

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:224

---

wheel

▸ wheel(e, deltas, global, emitter): void

Triggered when a wheel moves.

Parameters

Name	Type	Description
e	WheelEvent	a wheel event
deltas	UtilWheelEventDeltas	wheel move amounts
global	Point	a point wheel moved
emitter	EMITTER	an emitter

Returns

void

Inherited from

DDiagramBaseEvents.wheel

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:176

Edit this page.