Winter Cardinal UI - v0.457.0 / EShape

Interface: EShape

Hierarchy

• EventEmitter

  ↳ EShape

  ↳↳ EShapeLineOfAny

  ↳↳ EShapeConnector

  ↳↳ EShapeLayer

Implemented by

• EShapeBase

Table of contents

Properties

• action
• capability
• children
• connector
• corner
• cursor
• data
• editor
• fill
• gradient
• id
• image
• index
• interactive
• layout
• parent
• points
• radius
• reference
• root
• runtime
• selected
• shortcut
• size
• state
• stroke
• tag
• text
• texture
• title
• transform
• type
• uploaded
• uuid
• visible
• worldVisible

Methods

• addListener
• addUuid
• attach
• blur
• clone
• contains
• containsAbs
• containsAbsBBox
• containsBBox
• copy
• destroy
• detach
• emit
• eventNames
• focus
• getBounds
• getBoundsInternal
• getBoundsLocal
• getCapability
• listenerCount
• listeners
• lock
• off
• on
• onAttach
• onChildTransformChange
• onDetach
• onParentTransformChange
• onRender
• onSizeChange
• onTransformChange
• once
• removeAllListeners
• removeListener
• serialize
• toDirty
• toGlobal
• toLocal
• unlock
• update
• updateTransform
• updateUploaded
• updateUuid

Properties

action

• Readonly action: EShapeAction

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:49

---

capability

• Readonly capability: EShapeCapabilityContainer

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:82

---

children

• children: EShape[]

Defined in

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

---

connector

• connector: EShapeConnectorContainer

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:56

---

corner

• corner: number

Defined in

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

---

cursor

• Optional cursor: string

Defined in

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

---

data

• Readonly data: EShapeData

Defined in

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

---

editor

• Optional editor: EShapeEditor

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:73

---

fill

• Readonly fill: EShapeFill

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:36

---

gradient

• Optional gradient: EShapeGradientLike

Defined in

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

---

id

• id: string

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:32

---

image

• Optional image: EShapeImageLike

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:42

---

index

• index: number

Defined in

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

---

interactive

• interactive: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:53

---

layout

• Optional layout: EShapeLayout

Defined in

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

---

parent

• parent: null | EShape | EShapeContainer

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:59

---

points

• Optional Readonly points: EShapePoints

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:41

---

radius

• radius: number

Defined in

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

---

reference

• reference: number

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:67

---

root

• root: EShape

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:60

---

runtime

• Optional runtime: EShapeRuntime

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:70

---

selected

• selected: boolean

Defined in

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

---

shortcut

• Optional shortcut: string

Defined in

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

---

size

• Readonly size: IPoint

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:35

---

state

• Readonly state: EShapeStateSet

Defined in

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

---

stroke

• Readonly stroke: EShapeStroke

Defined in

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

---

tag

• Readonly tag: EShapeData

Deprecated

in favor of data.

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:47

---

text

• Readonly text: EShapeText

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:45

---

texture

• Optional texture: Texture

Defined in

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

---

title

• Optional title: string

Defined in

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

---

transform

• Readonly transform: EShapeTransform

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:38

---

type

• Readonly type: number

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:34

---

uploaded

• Optional uploaded: EShapeUploaded

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:76

---

uuid

• uuid: number

Defined in

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

---

visible

• visible: boolean

Defined in

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

---

worldVisible

• Readonly worldVisible: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:52

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

---

addUuid

▸ addUuid(manager): void

Parameters

Name	Type
manager	EShapeResourceManagerSerialization

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:122

---

attach

▸ attach(parent, at?): this

Parameters

Name	Type
parent	EShape | EShapeContainer
at?	number

Returns

this

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:87

---

blur

▸ blur(): this

Returns

this

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:98

---

clone

▸ clone(): EShape

Returns

EShape

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:93

---

contains

▸ contains(x, y): null | EShape

Parameters

Name	Type
x	number
y	number

Returns

null | EShape

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:126

---

containsAbs

▸ containsAbs(x, y, ax, ay, sw, ss, sa): boolean

Parameters

Name	Type
x	number
y	number
ax	number
ay	number
sw	number
ss	number
sa	number

Returns

boolean

Defined in

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

---

containsAbsBBox

▸ containsAbsBBox(x, y, ax, ay): boolean

Parameters

Name	Type
x	number
y	number
ax	number
ay	number

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:137

---

containsBBox

▸ containsBBox(x, y): boolean

Parameters

Name	Type
x	number
y	number

Returns

boolean

Defined in

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

---

copy

▸ copy(source): this

Parameters

Name	Type
source	EShape

Returns

this

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:91

▸ copy(source, part): this

Parameters

Name	Type
source	EShape
part	number

Returns

this

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:92

---

destroy

▸ destroy(): void

Returns

void

Defined in

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

---

detach

▸ detach(exceptions?): this

Parameters

Name	Type
exceptions?	Set<EShape>

Returns

this

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:89

---

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

---

focus

▸ focus(): this

Returns

this

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:97

---

getBounds

▸ getBounds(skipUpdate?, result?): Rectangle

Parameters

Name	Type
skipUpdate?	boolean
result?	Rectangle

Returns

Rectangle

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:142

---

getBoundsInternal

▸ getBoundsInternal(skipUpdate?, result?): Rectangle

Parameters

Name	Type
skipUpdate?	boolean
result?	Rectangle

Returns

Rectangle

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:143

---

getBoundsLocal

▸ getBoundsLocal(skipUpdate?, result?): Rectangle

Parameters

Name	Type
skipUpdate?	boolean
result?	Rectangle

Returns

Rectangle

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:144

---

getCapability

▸ getCapability(): undefined | EShapeCapabilityContainer

Returns

undefined | EShapeCapabilityContainer

Defined in

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

---

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

---

lock

▸ lock(part): this

Parameters

Name	Type
part	number

Returns

this

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:108

---

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

---

onAttach

▸ onAttach(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:88

---

onChildTransformChange

▸ onChildTransformChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:115

---

onDetach

▸ onDetach(exceptions?): void

Parameters

Name	Type
exceptions?	Set<EShape>

Returns

void

Defined in

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

---

onParentTransformChange

▸ onParentTransformChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:114

---

onRender

▸ onRender(time, renderer): void

Parameters

Name	Type
time	number
renderer	Renderer

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:105

---

onSizeChange

▸ onSizeChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:101

---

onTransformChange

▸ onTransformChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:113

---

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

---

serialize

▸ serialize(manager): DDiagramSerializedItem

Parameters

Name	Type
manager	EShapeResourceManagerSerialization

Returns

DDiagramSerializedItem

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:121

---

toDirty

▸ toDirty(): void

Returns

void

Defined in

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

---

toGlobal

▸ toGlobal(position, result, skipUpdate?): Point

Parameters

Name	Type
position	IPoint
result	Point
skipUpdate?	boolean

Returns

Point

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:140

---

toLocal

▸ toLocal(position, from?, result?, skipUpdate?): Point

Parameters

Name	Type
position	IPoint
from?	DisplayObject
result?	Point
skipUpdate?	boolean

Returns

Point

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:141

---

unlock

▸ unlock(part, invoke): this

Parameters

Name	Type
part	number
invoke	boolean

Returns

this

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:109

---

update

▸ update(time): void

Parameters

Name	Type
time	number

Returns

void

Defined in

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

---

updateTransform

▸ updateTransform(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:112

---

updateUploaded

▸ updateUploaded(recursively?): void

Parameters

Name	Type
recursively?	boolean

Returns

void

Defined in

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

---

updateUuid

▸ updateUuid(manager): void

Parameters

Name	Type
manager	EShapeResourceManagerSerialization

Returns

void

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape.ts:123

Edit this page.