Class EdgeElement

Hierarchy

AbstractElement
- EdgeElement

Index

Constructors

constructor

Properties

Accessors

Id

Methods

Constructors

constructor

new EdgeElement(id: Guid, properties: Dictionary<any>): EdgeElement

Inherited from AbstractElement.constructor
- Defined in AbstractElement.ts:16
Parameters
- id: Guid
  
  GUID of the Element that is created
- properties: Dictionary<any>
  
  of the Element
Returns EdgeElement

Properties

Protected childConnectorNeighbours

childConnectorNeighbours: Dictionary<Guid>

Protected childEdgeNeighbours

childEdgeNeighbours: Dictionary<Guid>

Protected childModelNeighbours

childModelNeighbours: Dictionary<Guid>

Protected childNodeNeighbours

childNodeNeighbours: Dictionary<Guid>

Protected end

end: Guid

Protected id

id: Guid

Protected parentConnectorNeighbours

parentConnectorNeighbours: Dictionary<Guid>

Protected parentEdgeNeighbours

parentEdgeNeighbours: Dictionary<Guid>

Protected parentModelNeighbours

parentModelNeighbours: Dictionary<Guid>

Protected parentNodeNeighbours

parentNodeNeighbours: Dictionary<Guid>

Protected properties

properties: Dictionary<any>

Protected start

start: Guid

Protected type

type: ElementType

Accessors

Id

get Id(): Guid

Inherited from AbstractElement.Id
- Defined in AbstractElement.ts:38
Returns identifier of this element

Returns Guid

Methods

addChildConnectorNeighbour

addChildConnectorNeighbour(id: Guid): void

Inherited from AbstractElement.addChildConnectorNeighbour
- Defined in AbstractElement.ts:115
Adds a neighbour of type Connector as child to this Element

Parameters
- id: Guid
  
  Guid of the element that should be added
Returns void

addChildEdgeNeighbour

addChildEdgeNeighbour(id: Guid): void

Inherited from AbstractElement.addChildEdgeNeighbour
- Defined in AbstractElement.ts:97
Adds a Neighbour of type Edge as child to this Element

Parameters
- id: Guid
  
  Guid of the element that should be added
Returns void

addChildModelNeighbour

addChildModelNeighbour(id: Guid): void

Inherited from AbstractElement.addChildModelNeighbour
- Defined in AbstractElement.ts:133
Adds a neighbour of type Model as child to this Element

Parameters
- id: Guid
  
  Guid of the element that should be added
Returns void

addChildNodeNeighbour

addChildNodeNeighbour(id: Guid): void

Inherited from AbstractElement.addChildNodeNeighbour
- Defined in AbstractElement.ts:79
Adds a neighbour of type Node as child to this Element

Parameters
- id: Guid
  
  Guid of the element that should be added
Returns void

addEndConnector

addEndConnector(connectorId: Guid): void

- Defined in EdgeElement.ts:44
Sets the EndConnector

Parameters
- connectorId: Guid
Returns void

addParentConnectorNeighbour

addParentConnectorNeighbour(id: Guid): void

Inherited from AbstractElement.addParentConnectorNeighbour
- Defined in AbstractElement.ts:106
Adds a neighbour of type Connector as parent to this Element

Parameters
- id: Guid
  
  Guid of the element that should be added
Returns void

addParentEdgeNeighbour

addParentEdgeNeighbour(id: Guid): void

Inherited from AbstractElement.addParentEdgeNeighbour
- Defined in AbstractElement.ts:88
Adds a Neighbour of type Edge as parent to this Element

Parameters
- id: Guid
  
  Guid of the element that should be added
Returns void

addParentModelNeighbour

addParentModelNeighbour(id: Guid): void

Inherited from AbstractElement.addParentModelNeighbour
- Defined in AbstractElement.ts:124
Adds a neighbour of type Model as parent to this Element

Parameters
- id: Guid
  
  Guid of the element that should be added
Returns void

addParentNodeNeighbour

addParentNodeNeighbour(id: Guid): void

Inherited from AbstractElement.addParentNodeNeighbour
- Defined in AbstractElement.ts:70
Adds a neighbour of type Node as parent to this Element

Parameters
- id: Guid
  
  Guid of the element that should be added
Returns void

addStartConnector

addStartConnector(connectorId: Guid): void

- Defined in EdgeElement.ts:34
Sets the StartConnector

Parameters
- connectorId: Guid
Returns void

delete

delete(graph: Graph): void

Overwrites AbstractElement.delete
- Defined in EdgeElement.ts:52
inheritdoc

Parameters
- graph: Graph
Returns void

deleteProperty

deleteProperty(name: string): void

Inherited from AbstractElement.deleteProperty
- Defined in AbstractElement.ts:209
Delete a property on this Element

Parameters
- name: string
  
  of the property
Returns void

getChildConnectorNeighbours

getChildConnectorNeighbours(): Guid[]

Inherited from AbstractElement.getChildConnectorNeighbours
- Defined in AbstractElement.ts:175
Returns all Child neighbours of type Connector

Returns Guid[]

getChildEdgeNeighbours

getChildEdgeNeighbours(): Guid[]

Inherited from AbstractElement.getChildEdgeNeighbours
- Defined in AbstractElement.ts:161
Returns all Child neighbours of type Edge

Returns Guid[]

getChildModelNeighbours

getChildModelNeighbours(): Guid[]

Inherited from AbstractElement.getChildModelNeighbours
- Defined in AbstractElement.ts:189
Returns all Children neighbous of type Model

Returns Guid[]

getChildNodeNeighbours

getChildNodeNeighbours(): Guid[]

Inherited from AbstractElement.getChildNodeNeighbours
- Defined in AbstractElement.ts:147
Returns all Child neighbours of type Node

Returns Guid[]

getConnectorNeighbours

getConnectorNeighbours(): Guid[]

- Defined in EdgeElement.ts:22
Override that ensures that the StartConnector is element 0, Endconnector is element 1 Any (potential) other connectors are at indices > 1

Returns Guid[]

getParentConnectorNeighbours

getParentConnectorNeighbours(): Guid[]

Inherited from AbstractElement.getParentConnectorNeighbours
- Defined in AbstractElement.ts:168
Returns all Parent neighbours of type Connector

Returns Guid[]

getParentEdgeNeighbours

getParentEdgeNeighbours(): Guid[]

Inherited from AbstractElement.getParentEdgeNeighbours
- Defined in AbstractElement.ts:154
Returns all Parent neighbours of type Edge

Returns Guid[]

getParentModelNeighbours

getParentModelNeighbours(): Guid[]

Inherited from AbstractElement.getParentModelNeighbours
- Defined in AbstractElement.ts:182
Returns all Parent neighbours of type Model

Returns Guid[]

getParentNodeNeighbours

getParentNodeNeighbours(): Guid[]

Inherited from AbstractElement.getParentNodeNeighbours
- Defined in AbstractElement.ts:140
Returns all Parent neighbours of type Node

Returns Guid[]

getProperties

getProperties(): Dictionary<any>

Inherited from AbstractElement.getProperties
- Defined in AbstractElement.ts:219
Returns all properties of this Element

Returns Dictionary<any>

getType

getType(): ElementType

Overwrites AbstractElement.getType
- Defined in EdgeElement.ts:14
inheritdoc

Returns ElementType

Protected remove

remove(graph: Graph): void

Inherited from AbstractElement.remove
- Defined in AbstractElement.ts:61
Internal function that removes THIS element ONLY. WARNING: This function does not perform a cascading delete (i.e remove orphan edges) Use delete() instead

Parameters
- graph: Graph
  
  Graph containing this element
Returns void

setProperty

setProperty(name: string, value: any): void

Inherited from AbstractElement.setProperty
- Defined in AbstractElement.ts:199
Sets a property on this Element

Parameters
- name: string
  
  Name of the property to set
- value: any
  
  desired value
Returns void

unlinkChildConnectorNeighbour

unlinkChildConnectorNeighbour(id: Guid): void

Inherited from AbstractElement.unlinkChildConnectorNeighbour
- Defined in AbstractElement.ts:246
Unlink a link to a neighbouring Child Connector

Parameters
- id: Guid
  
  Identifier of the Connector that should be unlinked
Returns void

unlinkChildEdgeNeighbour

unlinkChildEdgeNeighbour(id: Guid): void

Inherited from AbstractElement.unlinkChildEdgeNeighbour
- Defined in AbstractElement.ts:237
Unlink a link to a neighbouring Child Edge

Parameters
- id: Guid
  
  Identifier of the Child Edge that should be unlinked
Returns void

unlinkChildModelNeighbour

unlinkChildModelNeighbour(id: Guid): void

Inherited from AbstractElement.unlinkChildModelNeighbour
- Defined in AbstractElement.ts:255
Unlink a link to a neighbouring child Model

Parameters
- id: Guid
  
  Identifier of the child Model that should be unlinked
Returns void

unlinkChildNodeNeighbour

unlinkChildNodeNeighbour(id: Guid): void

Inherited from AbstractElement.unlinkChildNodeNeighbour
- Defined in AbstractElement.ts:228
Unlink a link to a neighbouring child Node

Parameters
- id: Guid
  
  Identifier of the child Node that should be unlinked
Returns void

Generated using TypeDoc