Winter Cardinal UI - v0.457.0 / DDiagramSnapshot

Class: DDiagramSnapshot<CANVAS>

Type parameters

Name	Type
CANVAS	extends DDiagramSnapshotCanvas = DDiagramSnapshotCanvas

Hierarchy

• EventEmitter

  ↳ DDiagramSnapshot

Table of contents

Constructors

• constructor

Properties

• _parent

Methods

• addListener
• create
• createAsFile
• createAsUrl
• emit
• eventNames
• listenerCount
• listeners
• off
• on
• once
• removeAllListeners
• removeListener
• toCleanupBackground
• toCleanupReflow
• toCleanupSnap
• toScale

Constructors

constructor

• new DDiagramSnapshot<CANVAS>(parent, options?): DDiagramSnapshot<CANVAS>

Type parameters

Name	Type
CANVAS	extends DDiagramSnapshotCanvas = DDiagramSnapshotCanvas

Parameters

Name	Type
parent	DDiagramSnapshotParent<CANVAS>
options?	DDiagramSnapshotOptions<CANVAS, any>

Returns

DDiagramSnapshot<CANVAS>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:88

Properties

_parent

• Protected _parent: DDiagramSnapshotParent<CANVAS>

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:86

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

---

create

▸ create<DATA>(options): undefined | DATA

Type parameters

Name
DATA

Parameters

Name	Type
options	DDiagramSnapshotCreateOptions<CANVAS, DATA>

Returns

undefined | DATA

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:234

---

createAsFile

▸ createAsFile(filename): void

Creates and downloads a snapshot.

Parameters

Name	Type	Description
filename	string	a filename

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:144

▸ createAsFile(size, filename): void

Creates and downloads a snapshot.

Parameters

Name	Type	Description
size	null | number	a maximum image size
filename	string	a filename

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:152

▸ createAsFile(options): void

Creates and downloads a snapshot.

Parameters

Name	Type	Description
options	DDiagramSnapshotCreateAsFileOptions	options

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:159

---

createAsUrl

▸ createAsUrl(size?): undefined | string

Creates a snapshot.

Parameters

Name	Type	Description
size?	null | number	a maximum image size

Returns

undefined | string

an URL of a created image or undefined

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:108

▸ createAsUrl(options): undefined | string

Creates a snapshot.

Parameters

Name	Type	Description
options	DDiagramSnapshotCreateAsUrlOptions	options

Returns

undefined | string

an URL of a created image or undefined

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:116

---

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

---

toCleanupBackground

▸ toCleanupBackground(options?): boolean

Parameters

Name	Type
options?	DDiagramSnapshotCreateOptions<CANVAS, unknown>

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:210

---

toCleanupReflow

▸ toCleanupReflow(options?): boolean

Parameters

Name	Type
options?	DDiagramSnapshotCreateOptions<CANVAS, unknown>

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:223

---

toCleanupSnap

▸ toCleanupSnap(options?): boolean

Parameters

Name	Type
options?	DDiagramSnapshotCreateOptions<CANVAS, unknown>

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-diagram-snapshot.ts:199

---

toScale

▸ toScale(size, canvas): number

Parameters

Name	Type
size	undefined | null | number
canvas	CANVAS

Returns

number

Defined in

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

Edit this page.