Class DiagramElement<M>

Type parameters

M: ModelElement

Hierarchy

Element
- DiagramElement
  - Handle
  - Shape
  - Edge

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new DiagramElement(): DiagramElement

Inherited from Element.constructor
- Defined in models/metamodel/Element.ts:14
Returns DiagramElement

Properties

Private _cursor

_cursor: Cursor = "default"

Private _hovered

_hovered: boolean = false

Private _modelElement

_modelElement: M

Private _ownedElements

_ownedElements: Array<DiagramElement<any>> = []

Private _owningElement

_owningElement: DiagramElement<any> | null = null

Private _selected

_selected: boolean = false

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

bounds

get bounds(): Bounds

- Defined in diagram/DiagramElement.ts:64
Returns Bounds

contents

get contents(): Set<Element>

Inherited from Element.contents
- Defined in models/metamodel/Element.ts:12
Returns Set<Element>

cursor

get cursor(): Cursor
set cursor(value: Cursor): void

- Defined in diagram/DiagramElement.ts:48
Returns Cursor
- Defined in diagram/DiagramElement.ts:52
Parameters
- value: Cursor
Returns void

hovered

get hovered(): boolean

- Defined in diagram/DiagramElement.ts:60
Returns boolean

modelElement

get modelElement(): M
set modelElement(m: M): void

- Defined in diagram/DiagramElement.ts:21
Returns M
- Defined in diagram/DiagramElement.ts:25
Parameters
- m: M
Returns void

ownedElements

get ownedElements(): Array<DiagramElement<any>>
set ownedElements(value: Array<DiagramElement<any>>): void

- Defined in diagram/DiagramElement.ts:30
Returns Array<DiagramElement<any>>
- Defined in diagram/DiagramElement.ts:34
Parameters
- value: Array<DiagramElement<any>>
Returns void

owningElement

get owningElement(): DiagramElement<any> | null
set owningElement(value: DiagramElement<any> | null): void

- Defined in diagram/DiagramElement.ts:39
Returns DiagramElement<any> | null
- Defined in diagram/DiagramElement.ts:43
Parameters
- value: DiagramElement<any> | null
Returns void

selected

get selected(): boolean

- Defined in diagram/DiagramElement.ts:56
Returns boolean

topLeft

get topLeft(): Point

- Defined in diagram/DiagramElement.ts:69
Returns the element's top left point

Returns Point

Methods

addListener

addListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:597
Parameters
- event: string | symbol
- listener: Function
Returns this

appendChild

appendChild(child: Element): void

Inherited from Element.appendChild
- Defined in models/metamodel/Element.ts:24
Appends a child to this element

Parameters
- child: Element
Returns void

calcAllElementBounds

calcAllElementBounds(): Bounds

- Defined in diagram/DiagramElement.ts:179
Returns Bounds

containsPoint

containsPoint(px: number, py: number): boolean

- Defined in diagram/DiagramElement.ts:89
Checks whether this element contains a given point

Parameters
- px: number
  
  X coordinate of the point to check
- py: number
  
  Y coordinate of the point to check
Returns boolean

createHandles

createHandles(canvas: Canvas): Handle[]

- Defined in diagram/DiagramElement.ts:79
Create handles for this element

Parameters
- canvas: Canvas
Returns Handle[]

deselect

deselect(): void

- Defined in diagram/DiagramElement.ts:116
Deselects the element

Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:607
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:608
Returns ( string | symbol ) []

getElementAtPosition

getElementAtPosition(canvas: Canvas, x: number, y: number): DiagramElement<any> | null

- Defined in diagram/DiagramElement.ts:163
Returns the element at a given position.

Parameters
- canvas: Canvas
- x: number
- y: number
Returns DiagramElement<any> | null

getHref

getHref(): string | undefined

Inherited from Element.getHref
- Defined in models/metamodel/Element.ts:38
Returns a hyper reference to this element

Returns string | undefined

getID

getID(): string | undefined

Inherited from Element.getID
- Defined in models/metamodel/Element.ts:66
Returns the ID of this element

Returns string | undefined

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:605
Returns number

getOrigin

getOrigin(): string | undefined

Inherited from Element.getOrigin
- Defined in models/metamodel/Element.ts:52
Returns the origin of this element

Returns string | undefined

getTypeName

getTypeName(): string | undefined

Inherited from Element.getTypeName
- Defined in models/metamodel/Element.ts:94
Returns the TypeName of this element

Returns string | undefined

getTypeURI

getTypeURI(): string | undefined

Inherited from Element.getTypeURI
- Defined in models/metamodel/Element.ts:80
Returns the TypeURI of this element

Returns string | undefined

hover

hover(val: boolean): void

- Defined in diagram/DiagramElement.ts:120
Parameters
- val: boolean
Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:609
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:606
Parameters
- event: string | symbol
Returns Function[]

merge

merge(other: Element): this

Inherited from Element.merge
- Defined in models/metamodel/Element.ts:103
Merges elements with each other

Parameters
- other: Element
  
  The element to merge
Returns this

move

move(dx: number, dy: number): void

- Defined in diagram/DiagramElement.ts:103
Move the element on the canvas

Parameters
- dx: number
- dy: number
Returns void

on

on(event: string | symbol, listener: Function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:598
Parameters
- event: string | symbol
- listener: Function
Returns this

onKeyPress

onKeyPress(key: string, i: InteractiveCanvas): void

- Defined in diagram/DiagramElement.ts:148
Called when a key is pressed on the element

Parameters
- key: string
  
  The key being pressed
- i: InteractiveCanvas
  
  The interactive canvas which is accepting drawing commands
Returns void

onMouseLeave

onMouseLeave(i: InteractiveCanvas): void

- Defined in diagram/DiagramElement.ts:139
Called when the mouse is leaving the element

Parameters
- i: InteractiveCanvas
  
  The interactive canvas which is accepting drawing commands
Returns void

onMouseMove

onMouseMove(x: number, y: number, i: InteractiveCanvas): void

- Defined in diagram/DiagramElement.ts:131
Called when the mouse is moved over the element

Parameters
- x: number
  
  X position on element
- y: number
  
  Y position on element
- i: InteractiveCanvas
  
  The interactive canvas which is accepting drawing commands
Returns void

onTick

onTick(time: number, i: InteractiveCanvas): void

- Defined in diagram/DiagramElement.ts:157
Called when a key is pressed on the element

Parameters
- time: number
  
  An integer representing the clock
- i: InteractiveCanvas
  
  The interactive canvas which is accepting drawing commands
Returns void

once

once(event: string | symbol, listener: Function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:599
Parameters
- event: string | symbol
- listener: Function
Returns this

prependListener

prependListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:600
Parameters
- event: string | symbol
- listener: Function
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:601
Parameters
- event: string | symbol
- listener: Function
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:603
Parameters
- Optional event: string | symbol
Returns this

removeChild

removeChild(child: Element): boolean

Inherited from Element.removeChild
- Defined in models/metamodel/Element.ts:31
Removes a child from this element

Parameters
- child: Element
Returns boolean

removeListener

removeListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:602
Parameters
- event: string | symbol
- listener: Function
Returns this

render

render(canvas: Canvas): void

- Defined in diagram/DiagramElement.ts:73
Parameters
- canvas: Canvas
Returns void

select

select(): void

- Defined in diagram/DiagramElement.ts:109
Selects the element

Returns void

setID

setID(ID: string | undefined): void

Inherited from Element.setID
- Defined in models/metamodel/Element.ts:59
Sets the element's ID

Parameters
- ID: string | undefined
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:604
Parameters
- n: number
Returns this

setOrigin

setOrigin(origin: string): void

Inherited from Element.setOrigin
- Defined in models/metamodel/Element.ts:45
Sets the element's origin

Parameters
- origin: string
Returns void

setTypeName

setTypeName(name: string | undefined): void

Inherited from Element.setTypeName
- Defined in models/metamodel/Element.ts:87
Sets the element's type name

Parameters
- name: string | undefined
Returns void

setTypeURI

setTypeURI(uri: string | undefined): void

Inherited from Element.setTypeURI
- Defined in models/metamodel/Element.ts:73
Sets the element's type URI

Parameters
- uri: string | undefined
Returns void

toString

toString(): string

- Defined in diagram/DiagramElement.ts:96
Returns a meaningful string representation

Returns string

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /home/moellers/Projects/Masterarbeit/ModelInterchange/node_modules/@types/node/index.d.ts:594
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc