Winter Cardinal UI - v0.457.0 / EShapeActions

Class: EShapeActions

Table of contents

Constructors

• constructor

Properties

• SHAPE

Methods

• emit
• getDiagram
• getShape
• isDiagram
• isEmbedded
• open
• toDiagram
• writeLocal
• writeRemote

Constructors

constructor

• new EShapeActions(): EShapeActions

Returns

EShapeActions

Properties

SHAPE

▪ Static SHAPE: null | EShape = null

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:19

Methods

emit

▸ emit(shape, name): void

Parameters

Name	Type
shape	EShape
name	string

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:127

▸ emit(shape, name, value, time): void

Parameters

Name	Type
shape	EShape
name	string
value	unknown
time	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:128

---

getDiagram

▸ getDiagram(): null | DDiagram<DThemeDiagram, DDiagramOptions<DThemeDiagram, any>>

Returns

null | DDiagram<DThemeDiagram, DDiagramOptions<DThemeDiagram, any>>

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:25

---

getShape

▸ getShape(): null | EShape

Returns

null | EShape

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:21

---

isDiagram

▸ isDiagram(target): target is DDiagram<DThemeDiagram, DDiagramOptions<DThemeDiagram, any>>

Parameters

Name	Type
target	unknown

Returns

target is DDiagram<DThemeDiagram, DDiagramOptions<DThemeDiagram, any>>

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:29

---

isEmbedded

▸ isEmbedded(target): target is EShapeEmbedded

Parameters

Name	Type
target	unknown

Returns

target is EShapeEmbedded

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:33

---

open

▸ open(shape, type, target, inNewWindow, environment): void

Parameters

Name	Type
shape	EShape
type	number
target	unknown
inNewWindow	boolean
environment	EShapeActionEnvironment

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:48

---

toDiagram

▸ toDiagram(shape?): null | DDiagram<DThemeDiagram, DDiagramOptions<DThemeDiagram, any>>

Parameters

Name	Type
shape?	null | EShape

Returns

null | DDiagram<DThemeDiagram, DDiagramOptions<DThemeDiagram, any>>

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:37

---

writeLocal

▸ writeLocal(shape, id, value, time, state?): boolean

Parameters

Name	Type	Default value
shape	EShape	undefined
id	string	undefined
value	unknown	undefined
time	number	undefined
state	number	EShapeDataValueState.FOUND

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:85

---

writeRemote

▸ writeRemote(shape, id, value): boolean

Parameters

Name	Type
shape	EShape
id	string
value	unknown

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-actions.ts:119

Edit this page.