Winter Cardinal UI - v0.442.0 / ESnapperTarget
EventEmitter
↳ ESnapperTarget
• new ESnapperTarget(theme
, options?
): ESnapperTarget
Name | Type |
---|---|
theme |
EThemeSnapperTarget |
options? |
ESnapperTargetOptions |
utils.EventEmitter.constructor
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:31
• Protected
_isEnabled: boolean
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:28
• Protected
_isEnabledDefault: boolean
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:29
• Protected
_isVisible: boolean
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:26
• Protected
_isVisibleDefault: boolean
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:27
• values: ESnapperTargetValue
[]
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:25
• get
enable(): boolean
boolean
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:40
• set
enable(enable
): void
Name | Type |
---|---|
enable |
boolean |
void
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:44
• get
size(): number
number
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:62
• get
visible(): boolean
boolean
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:51
• set
visible(visible
): void
Name | Type |
---|---|
visible |
boolean |
void
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:55
▸ add(target
, index?
): void
Name | Type |
---|---|
target |
ESnapperTargetValue |
index? |
number |
void
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:66
▸ addListener(event
, fn
, context?
): this
Alias method for on
Name | Type |
---|---|
event |
string | symbol |
fn |
Function |
context? |
any |
this
utils.EventEmitter.addListener
node_modules/pixi.js/pixi.js.d.ts:25495
▸ deserialize(serialized
): void
Name | Type |
---|---|
serialized |
DDiagramSerializedSnapTarget |
void
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:134
▸ emit(event
, ...args
): boolean
Calls each of the listeners registered for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
...args |
any [] |
Arguments that are passed to registered listeners |
boolean
true
if the event had listeners, else false
.
utils.EventEmitter.emit
node_modules/pixi.js/pixi.js.d.ts:25441
▸ eventNames(): (string
| symbol
)[]
Return an array listing the events for which the emitter has registered listeners.
(string
| symbol
)[]
utils.EventEmitter.eventNames
node_modules/pixi.js/pixi.js.d.ts:25415
▸ listenerCount(event
): number
Return the number of listeners listening to a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
number
utils.EventEmitter.listenerCount
node_modules/pixi.js/pixi.js.d.ts:25432
▸ listeners(event
): Function
[]
Return the listeners registered for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
Function
[]
utils.EventEmitter.listeners
node_modules/pixi.js/pixi.js.d.ts:25424
▸ off(event
, fn?
, context?
, once?
): this
Alias method for removeListener
Name | Type |
---|---|
event |
string | symbol |
fn? |
Function |
context? |
any |
once? |
boolean |
this
utils.EventEmitter.off
node_modules/pixi.js/pixi.js.d.ts:25489
▸ on(event
, fn
, context?
): this
Add a listener for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
fn |
Function |
The listener function. |
context? |
any |
The context to invoke the listener with. |
this
this
.
utils.EventEmitter.on
node_modules/pixi.js/pixi.js.d.ts:25452
▸ once(event
, fn
, context?
): this
Add a one-time listener for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
fn |
Function |
The listener function. |
context? |
any |
The context to invoke the listener with. |
this
this
.
utils.EventEmitter.once
node_modules/pixi.js/pixi.js.d.ts:25463
▸ remove(index
): void
Name | Type |
---|---|
index |
number |
void
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:75
▸ removeAllListeners(event?
): this
Remove all listeners, or those of the specified event.
Name | Type | Description |
---|---|---|
event? |
string | symbol |
The event name. |
this
this
.
utils.EventEmitter.removeAllListeners
node_modules/pixi.js/pixi.js.d.ts:25483
▸ removeListener(event
, fn?
, context?
, once?
): this
Remove the listeners of a given event.
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. |
this
this
.
utils.EventEmitter.removeListener
node_modules/pixi.js/pixi.js.d.ts:25475
▸ replace(index
, value
): null
| ESnapperTargetValue
Name | Type |
---|---|
index |
number |
value |
ESnapperTargetValue |
null
| ESnapperTargetValue
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:83
▸ reset(): void
void
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:118
▸ serialize(): DDiagramSerializedSnapTarget
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:125
▸ snap(px
, py
, x
, y
): void
Name | Type |
---|---|
px |
number |
py |
number |
x |
ESnapperResult |
y |
ESnapperResult |
void
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:104
▸ swap(indexA
, indexB
): void
Name | Type |
---|---|
indexA |
number |
indexB |
number |
void
src/main/typescript/wcardinal/ui/snapper/e-snapper-target.ts:94