Winter Cardinal UI - v0.457.0 / DDiagramShape

Class: DDiagramShape

A shape helper class for diagrams.

Hierarchy

• EventEmitter

  ↳ DDiagramShape

Table of contents

Constructors

• constructor

Properties

• _diagram
• _updateBound

Methods

• addListener
• each
• emit
• eventNames
• get
• getAll
• listenerCount
• listeners
• off
• on
• once
• removeAllListeners
• removeListener
• update

Constructors

constructor

• new DDiagramShape(diagram): DDiagramShape

Parameters

Name	Type
diagram	DDiagramShapeDiagram

Returns

DDiagramShape

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-diagram-shape.ts:38

Properties

_diagram

• Protected _diagram: DDiagramShapeDiagram

Defined in

src/main/typescript/wcardinal/ui/d-diagram-shape.ts:35

---

_updateBound

• Protected _updateBound: () => void

Type declaration

▸ (): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-shape.ts:36

Methods

addListener

▸ addListener(event, fn, context?): this

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Inherited from

utils.EventEmitter.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25495

---

each

▸ each(iteratee, reverse?): null | EShape

Parameters

Name	Type	Default value
iteratee	(shape: EShape) => boolean | void	undefined
reverse	boolean	false

Returns

null | EShape

Defined in

src/main/typescript/wcardinal/ui/d-diagram-shape.ts:69

---

emit

▸ emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
...args	any[]	Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Inherited from

utils.EventEmitter.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441

---

eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Inherited from

utils.EventEmitter.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415

---

get

▸ get(id): null | EShape

Parameters

Name	Type
id	string

Returns

null | EShape

Defined in

src/main/typescript/wcardinal/ui/d-diagram-shape.ts:53

---

getAll

▸ getAll(id): EShape[]

Parameters

Name	Type
id	string

Returns

EShape[]

Defined in

src/main/typescript/wcardinal/ui/d-diagram-shape.ts:61

---

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

number

Inherited from

utils.EventEmitter.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432

---

listeners

▸ listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

Function[]

Inherited from

utils.EventEmitter.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424

---

off

▸ off(event, fn?, context?, once?): this

Alias method for removeListener

Parameters

Name	Type
event	string | symbol
fn?	Function
context?	any
once?	boolean

Returns

this

Inherited from

utils.EventEmitter.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25489

---

on

▸ on(event, fn, context?): this

Add a listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Inherited from

utils.EventEmitter.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25452

---

once

▸ once(event, fn, context?): this

Add a one-time listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Inherited from

utils.EventEmitter.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25463

---

removeAllListeners

▸ removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Parameters

Name	Type	Description
event?	string | symbol	The event name.

Returns

this

this.

Inherited from

utils.EventEmitter.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25483

---

removeListener

▸ removeListener(event, fn?, context?, once?): this

Remove the listeners of a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn?	Function	Only remove the listeners that match this function.
context?	any	Only remove the listeners that have this context.
once?	boolean	Only remove one-time listeners.

Returns

this

this.

Inherited from

utils.EventEmitter.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25475

---

update

▸ update(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-shape.ts:46

Edit this page.