Class GrapholEdge

Export

Interface

Edge

Hierarchy

GrapholElement
- GrapholEdge

Implements

Edge

Constructors

constructor

new GrapholEdge(id: string, type: TypesEnum): GrapholEdge
Parameters
- id: string
- type: TypesEnum
Returns GrapholEdge
Overrides GrapholElement.constructor
- Defined in src/model/graphol-elems/edge.ts:44

Properties

`Private` _breakpoints

_breakpoints: Breakpoint[] = []

`Private` `Optional` _sourceEndpoint

_sourceEndpoint?: Position

`Private` _sourceId

_sourceId: string

`Private` `Optional` _sourceLabel

_sourceLabel?: string

`Private` `Optional` _targetEndpoint

_targetEndpoint?: Position

`Private` _targetId

_targetId: string

`Private` `Optional` _targetLabel

_targetLabel?: string

`Optional` domainMandatory

domainMandatory?: boolean

Memberof

Edge

`Optional` domainTyped

domainTyped?: boolean

Memberof

Edge

`Optional` rangeMandatory

rangeMandatory?: boolean

Memberof

Edge

`Optional` rangeTyped

rangeTyped?: boolean

Memberof

Edge

Accessors

breakpoints

get breakpoints(): Breakpoint[]
Returns an array of mid-edge breakpoints (without source/target endpoints)

Returns Breakpoint[]
Implementation of Edge.breakpoints
- Defined in src/model/graphol-elems/edge.ts:91

controlpoints

get controlpoints(): Breakpoint[]
Returns an array of all the breakpoints (including source/target endpoints)

Returns Breakpoint[]
- Defined in src/model/graphol-elems/edge.ts:98
set controlpoints(newControlPoints: Breakpoint[]): void
Parameters
- newControlPoints: Breakpoint[]
Returns void
- Defined in src/model/graphol-elems/edge.ts:102

diagramId

get diagramId(): number
Memberof
Edge

Returns number
Implementation of Edge.diagramId

Inherited from GrapholElement.diagramId
- Defined in src/model/graphol-elems/graphol-element.ts:36
set diagramId(newdiagramId: number): void
Memberof
Edge
Parameters
- newdiagramId: number
Returns void
Implementation of Edge.diagramId

Inherited from GrapholElement.diagramId
- Defined in src/model/graphol-elems/graphol-element.ts:37

displayedName

get displayedName(): undefined | string
Memberof
Edge

Returns undefined | string
Implementation of Edge.displayedName

Inherited from GrapholElement.displayedName
- Defined in src/model/graphol-elems/graphol-element.ts:25
set displayedName(displayedName: undefined | string): void
Memberof
Edge
Parameters
- displayedName: undefined | string
Returns void
Implementation of Edge.displayedName

Inherited from GrapholElement.displayedName
- Defined in src/model/graphol-elems/graphol-element.ts:26

id

get id(): string
Memberof
Edge

Returns string
Implementation of Edge.id

Inherited from GrapholElement.id
- Defined in src/model/graphol-elems/graphol-element.ts:15
set id(value: string): void
Memberof
Edge
Parameters
- value: string
Returns void
Implementation of Edge.id

Inherited from GrapholElement.id
- Defined in src/model/graphol-elems/graphol-element.ts:16

iri

get iri(): undefined | string
Memberof
Edge

Returns undefined | string
Implementation of Edge.iri

Inherited from GrapholElement.iri
- Defined in src/model/graphol-elems/graphol-element.ts:33
set iri(iri: undefined | string): void
Memberof
Edge
Parameters
- iri: undefined | string
Returns void
Implementation of Edge.iri

Inherited from GrapholElement.iri
- Defined in src/model/graphol-elems/graphol-element.ts:34

originalId

get originalId(): undefined | string
In case of replicated elements, this is the ID of the original element replicated in multiple occurrences, all of them with different IDs

Memberof
Edge

Returns undefined | string
Implementation of Edge.originalId

Inherited from GrapholElement.originalId
- Defined in src/model/graphol-elems/graphol-element.ts:30
set originalId(id: undefined | string): void
In case of replicated elements, this is the ID of the original element replicated in multiple occurrences, all of them with different IDs

Memberof
Edge
Parameters
- id: undefined | string
Returns void
Implementation of Edge.originalId

Inherited from GrapholElement.originalId
- Defined in src/model/graphol-elems/graphol-element.ts:31

sourceEndpoint

get sourceEndpoint(): undefined | Position
Returns undefined | Position
- Defined in src/model/graphol-elems/edge.ts:70
set sourceEndpoint(endpoint: undefined | Position): void
Parameters
- endpoint: undefined | Position
Returns void
- Defined in src/model/graphol-elems/edge.ts:74

sourceId

get sourceId(): string
Memberof
Edge

Returns string
Implementation of Edge.sourceId
- Defined in src/model/graphol-elems/edge.ts:106
set sourceId(sourceId: string): void
Memberof
Edge
Parameters
- sourceId: string
Returns void
Implementation of Edge.sourceId
- Defined in src/model/graphol-elems/edge.ts:109

sourceLabel

get sourceLabel(): undefined | string
Returns undefined | string
- Defined in src/model/graphol-elems/edge.ts:127
set sourceLabel(sourceLabel: undefined | string): void
Parameters
- sourceLabel: undefined | string
Returns void
- Defined in src/model/graphol-elems/edge.ts:130

targetEndpoint

get targetEndpoint(): undefined | Position
Returns undefined | Position
- Defined in src/model/graphol-elems/edge.ts:79
set targetEndpoint(endpoint: undefined | Position): void
Parameters
- endpoint: undefined | Position
Returns void
- Defined in src/model/graphol-elems/edge.ts:83

targetId

get targetId(): string
Memberof
Edge

Returns string
Implementation of Edge.targetId
- Defined in src/model/graphol-elems/edge.ts:113
set targetId(targetId: string): void
Memberof
Edge
Parameters
- targetId: string
Returns void
Implementation of Edge.targetId
- Defined in src/model/graphol-elems/edge.ts:116

targetLabel

get targetLabel(): undefined | string
Returns undefined | string
- Defined in src/model/graphol-elems/edge.ts:120
set targetLabel(targetLabel: undefined | string): void
Parameters
- targetLabel: undefined | string
Returns void
- Defined in src/model/graphol-elems/edge.ts:123

type

get type(): TypesEnum
Memberof
Edge

Returns TypesEnum
Implementation of Edge.type

Overrides GrapholElement.type
- Defined in src/model/graphol-elems/edge.ts:134
set type(newType: TypesEnum): void
Memberof
Edge
Parameters
- newType: TypesEnum
Returns void
Implementation of Edge.type

Overrides GrapholElement.type
- Defined in src/model/graphol-elems/edge.ts:135

Methods

addBreakPoint

addBreakPoint(breakpoint: Breakpoint): void
Parameters
- breakpoint: Breakpoint
Returns void
- Defined in src/model/graphol-elems/edge.ts:57

clone

clone(): GrapholEdge
Returns GrapholEdge
Overrides GrapholElement.clone
- Defined in src/model/graphol-elems/edge.ts:171

computeBreakpointsDistancesWeights

computeBreakpointsDistancesWeights(sourcePosition: Position, targetPosition: Position): void
Parameters
- sourcePosition: Position
- targetPosition: Position
Returns void
- Defined in src/model/graphol-elems/edge.ts:64

equals

equals(grapholElement: GrapholElement): boolean
Parameters
- grapholElement: GrapholElement
Returns boolean
Inherited from GrapholElement.equals
- Defined in src/model/graphol-elems/graphol-element.ts:108

getCytoscapeRepr

getCytoscapeRepr(grapholEntity?: GrapholEntity): ElementDefinition[]
Parameters
- Optional grapholEntity: GrapholEntity
Returns ElementDefinition[]
Overrides GrapholElement.getCytoscapeRepr
- Defined in src/model/graphol-elems/edge.ts:149

is

is(type: TypesEnum): boolean
Check if element is of a certain type
Parameters
- type: TypesEnum
Returns boolean
Inherited from GrapholElement.is
- Defined in src/model/graphol-elems/graphol-element.ts:45

isEdge

isEdge(): this is GrapholEdge
Returns this is GrapholEdge
Inherited from GrapholElement.isEdge
- Defined in src/model/graphol-elems/graphol-element.ts:120

isEntity

isEntity(): boolean
Returns
whether node is an entity

Returns boolean
Inherited from GrapholElement.isEntity
- Defined in src/model/graphol-elems/graphol-element.ts:55

isHierarchy

isHierarchy(): boolean
Returns boolean
Overrides GrapholElement.isHierarchy
- Defined in src/model/graphol-elems/edge.ts:142

Class GrapholEdge

Export

Interface

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

type: TypesEnum

Returns GrapholEdge

Properties

Private _breakpoints

Private Optional _sourceEndpoint

Private _sourceId

Private Optional _sourceLabel

Private Optional _targetEndpoint

Private _targetId

Private Optional _targetLabel

Optional domainMandatory

Memberof

Optional domainTyped

Memberof

Optional rangeMandatory

Memberof

Optional rangeTyped

Memberof

Accessors

breakpoints

Returns Breakpoint[]

controlpoints

Returns Breakpoint[]

Parameters

newControlPoints: Breakpoint[]

Returns void

diagramId

Memberof

Returns number

Memberof

Parameters

newdiagramId: number

Returns void

displayedName

Memberof

Returns undefined | string

Memberof

Parameters

displayedName: undefined | string

Returns void

id

Memberof

Returns string

Memberof

Parameters

value: string

Returns void

iri

Memberof

Returns undefined | string

Memberof

Parameters

iri: undefined | string

Returns void

originalId

Memberof

Returns undefined | string

Memberof

Parameters

id: undefined | string

Returns void

sourceEndpoint

Returns undefined | Position

Parameters

endpoint: undefined | Position

Returns void

`Private` _breakpoints

`Private` `Optional` _sourceEndpoint

`Private` _sourceId

`Private` `Optional` _sourceLabel

`Private` `Optional` _targetEndpoint

`Private` _targetId

`Private` `Optional` _targetLabel

`Optional` domainMandatory

`Optional` domainTyped

`Optional` rangeMandatory

`Optional` rangeTyped

`Optional` grapholEntity: GrapholEntity