Winter Cardinal UI - v0.457.0 / ESnapperTarget

Class: ESnapperTarget

Hierarchy

• EventEmitter

  ↳ ESnapperTarget

Table of contents

Constructors

• constructor

Properties

• _isEnabled
• _isEnabledDefault
• _isVisible
• _isVisibleDefault
• values

Accessors

• enable
• size
• visible

Methods

• add
• addListener
• deserialize
• emit
• eventNames
• listenerCount
• listeners
• off
• on
• once
• remove
• removeAllListeners
• removeListener
• replace
• reset
• serialize
• snap
• swap

Constructors

constructor

• new ESnapperTarget(theme, options?): ESnapperTarget

Parameters

Name	Type
theme	EThemeSnapperTarget
options?	ESnapperTargetOptions

Returns

ESnapperTarget

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:31

Properties

_isEnabled

• Protected _isEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:28

---

_isEnabledDefault

• Protected _isEnabledDefault: boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:29

---

_isVisible

• Protected _isVisible: boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:26

---

_isVisibleDefault

• Protected _isVisibleDefault: boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:27

---

values

• values: ESnapperTargetValue[]

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:25

Accessors

enable

• get enable(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:40

• set enable(enable): void

Parameters

Name	Type
enable	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:44

---

size

• get size(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:62

---

visible

• get visible(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:51

• set visible(visible): void

Parameters

Name	Type
visible	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:55

Methods

add

▸ add(target, index?): void

Parameters

Name	Type
target	ESnapperTargetValue
index?	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:66

---

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

---

deserialize

▸ deserialize(serialized): void

Parameters

Name	Type
serialized	DDiagramSerializedSnapTarget

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:134

---

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

---

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

---

remove

▸ remove(index): void

Parameters

Name	Type
index	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:75

---

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

---

replace

▸ replace(index, value): null | ESnapperTargetValue

Parameters

Name	Type
index	number
value	ESnapperTargetValue

Returns

null | ESnapperTargetValue

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:83

---

reset

▸ reset(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:118

---

serialize

▸ serialize(): DDiagramSerializedSnapTarget

Returns

DDiagramSerializedSnapTarget

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:125

---

snap

▸ snap(px, py, x, y): void

Parameters

Name	Type
px	number
py	number
x	ESnapperResult
y	ESnapperResult

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:104

---

swap

▸ swap(indexA, indexB): void

Parameters

Name	Type
indexA	number
indexB	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:94

Edit this page.