Class Diagram

Hierarchy

Shape<Package>
- Diagram
  - ClassDiagram

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Diagram(): Diagram

Inherited from Shape.constructor

Overrides Element.constructor
- Defined in diagram/Shape.ts:18
Returns Diagram

Properties

Private _documentation

_documentation: string

Private _name

_name: string

Private _resolution

_resolution: number = 300

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

bounds

get bounds(): Bounds

Inherited from Shape.bounds

Overrides DiagramElement.bounds
- Defined in diagram/Shape.ts:60
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

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

documentation

get documentation(): string
set documentation(value: string): void

- Defined in diagram/Diagram.ts:23
Returns string
- Defined in diagram/Diagram.ts:27
Parameters
- value: string
Returns void

fill

get fill(): Fill

Inherited from Shape.fill
- Defined in diagram/Shape.ts:45
Returns Fill

font

get font(): Font

Inherited from Shape.font
- Defined in diagram/Shape.ts:55
Returns Font

hovered

get hovered(): boolean

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

modelElement

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

Inherited from DiagramElement.modelElement
- Defined in diagram/DiagramElement.ts:21
Returns Package
Inherited from DiagramElement.modelElement
- Defined in diagram/DiagramElement.ts:25
Parameters
- m: Package
Returns void

name

get name(): string
set name(value: string): void

- Defined in diagram/Diagram.ts:14
Returns string
- Defined in diagram/Diagram.ts:18
Parameters
- value: string
Returns void

ownedElements

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

Inherited from DiagramElement.ownedElements
- Defined in diagram/DiagramElement.ts:30
Returns Array<DiagramElement<any>>
Inherited from DiagramElement.ownedElements
- 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

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

resolution

get resolution(): number
set resolution(value: number): void

- Defined in diagram/Diagram.ts:32
Returns number
- Defined in diagram/Diagram.ts:36
Parameters
- value: number
Returns void

selected

get selected(): boolean

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

stroke

get stroke(): Stroke

Inherited from Shape.stroke
- Defined in diagram/Shape.ts:50
Returns Stroke

topLeft

get topLeft(): Point

Inherited from Shape.topLeft

Overrides DiagramElement.topLeft
- Defined in diagram/Shape.ts:64
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

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

center

center(): Point

Inherited from Shape.center
- Defined in diagram/Shape.ts:102
Returns the center point of this element

Returns Point

containsPoint

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

Overrides Shape.containsPoint
- Defined in diagram/Diagram.ts:40
Parameters
- px: number
- py: number
Returns boolean

createHandles

createHandles(canvas: Canvas): Handle[]

Inherited from Shape.createHandles

Overrides DiagramElement.createHandles
- Defined in diagram/Shape.ts:81
Parameters
- canvas: Canvas
Returns Handle[]

deselect

deselect(): void

Inherited from DiagramElement.deselect
- 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

Overrides DiagramElement.getElementAtPosition
- Defined in diagram/Diagram.ts:51
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

Inherited from DiagramElement.hover
- 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

Inherited from Shape.move

Overrides DiagramElement.move
- Defined in diagram/Shape.ts:119
override

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

Inherited from DiagramElement.onKeyPress
- 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

Inherited from DiagramElement.onMouseLeave
- 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

Inherited from DiagramElement.onMouseMove
- 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

Inherited from DiagramElement.onTick
- 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

Overrides Shape.render
- Defined in diagram/Diagram.ts:45
Parameters
- canvas: Canvas
Returns void

renderContents

renderContents(canvas: Canvas): void

Inherited from Shape.renderContents
- Defined in diagram/Shape.ts:96
Parameters
- canvas: Canvas
Returns void

select

select(): void

Inherited from DiagramElement.select
- 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

Inherited from DiagramElement.toString
- 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