Winter Cardinal UI - v0.457.0 / ESnapperGrid

Class: ESnapperGrid

Hierarchy

• EventEmitter

  ↳ ESnapperGrid

Table of contents

Constructors

• constructor

Properties

• _isEnabled
• _isEnabledDefault
• _isVisible
• _isVisibleDefault
• _size
• _sizeDefault

Accessors

• enable
• size
• visible

Methods

• addListener
• deserialize
• emit
• eventNames
• listenerCount
• listeners
• off
• on
• once
• removeAllListeners
• removeListener
• reset
• serialize
• snap

Constructors

constructor

• new ESnapperGrid(theme, options?): ESnapperGrid

Parameters

Name	Type
theme	EThemeSnapperGrid
options?	ESnapperGridOptions

Returns

ESnapperGrid

Overrides

utils.EventEmitter.constructor

Defined in

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

Properties

_isEnabled

• Protected _isEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:22

---

_isEnabledDefault

• Protected _isEnabledDefault: boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:23

---

_isVisible

• Protected _isVisible: boolean

Defined in

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

---

_isVisibleDefault

• Protected _isVisibleDefault: boolean

Defined in

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

---

_size

• Protected _size: number

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:24

---

_sizeDefault

• Protected _sizeDefault: number

Defined in

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

Accessors

enable

• get enable(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:50

• set enable(enable): void

Parameters

Name	Type
enable	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:54

---

size

• get size(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:61

• set size(size): void

Parameters

Name	Type
size	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:65

---

visible

• get visible(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:39

• set visible(visible): void

Parameters

Name	Type
visible	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:43

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

---

deserialize

▸ deserialize(serialized): void

Parameters

Name	Type
serialized	DDiagramSerializedSnapGrid

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:90

---

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

---

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

---

reset

▸ reset(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:79

---

serialize

▸ serialize(): DDiagramSerializedSnapGrid

Returns

DDiagramSerializedSnapGrid

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:86

---

snap

▸ snap(value, result): void

Parameters

Name	Type
value	number
result	ESnapperResult

Returns

void

Defined in

src/main/typescript/wcardinal/ui/snapper/e-snapper-grid.ts:72

Edit this page.