Class DiagramBuilder

Hierarchy

DiagramBuilder

Constructors

constructor

new DiagramBuilder(diagram: Diagram, rendererState: RendererStatesEnum): DiagramBuilder
Parameters
- diagram: Diagram
- rendererState: RendererStatesEnum
Returns DiagramBuilder
- Defined in src/core/diagram-builder.ts:6

Properties

diagram

diagram: Diagram

`Private` rendererState

rendererState: RendererStatesEnum

Accessors

diagramRepresentation

get diagramRepresentation(): undefined | DiagramRepresentation
Returns undefined | DiagramRepresentation
- Defined in src/core/diagram-builder.ts:370

Methods

addAnnotationProperty

addAnnotationProperty(annotationPropertyEdge: GrapholEntity, sourceEntity: GrapholEntity, targetEntity: GrapholEntity, nodesType: TypesEnum[], annotationPropertyElement?: GrapholEdge): undefined | GrapholElement
Add an annotation property between two entities. If the source and/or target entities are already present in graph, they won't be added again. If there already exists an annotation property between them with the same IRI, the edge won't be added.

Returns
Parameters
- annotationPropertyEdge: GrapholEntity
  
  the object property entity
- sourceEntity: GrapholEntity
  
  the source entity
- targetEntity: GrapholEntity
  
  the target entity
- nodesType: TypesEnum[]
  
  the type of source and target
- Optional annotationPropertyElement: GrapholEdge
  
  [optional] to use your own GrapholEdge for the object property occurrence. if you don't pass this, a new GrapholEdge will be created from scratch
Returns undefined | GrapholElement
- Defined in src/core/diagram-builder.ts:130

addClass

addClass(classEntity: GrapholEntity, classNode?: GrapholNode): GrapholNode
Parameters
- classEntity: GrapholEntity
- Optional classNode: GrapholNode
Returns GrapholNode
- Defined in src/core/diagram-builder.ts:8
addClass(classEntity: GrapholEntity, position?: Position): GrapholNode
Parameters
- classEntity: GrapholEntity
- Optional position: Position
Returns GrapholNode
- Defined in src/core/diagram-builder.ts:9
addClass(classEntity: GrapholEntity): GrapholNode
Parameters
- classEntity: GrapholEntity
Returns GrapholNode
- Defined in src/core/diagram-builder.ts:10

addDataProperty

addDataProperty(dataPropertyEntity: GrapholEntity, ownerEntity?: GrapholEntity): undefined | GrapholElement
Parameters
- dataPropertyEntity: GrapholEntity
- Optional ownerEntity: GrapholEntity
Returns undefined | GrapholElement
- Defined in src/core/diagram-builder.ts:48

addEdge

addEdge(sourceId: string, targetId: string, edgeType: UNION | COMPLETE_UNION | DISJOINT_UNION | COMPLETE_DISJOINT_UNION | INCLUSION | EQUIVALENCE | INSTANCE_OF | INPUT | ATTRIBUTE_EDGE): undefined | GrapholElement
Parameters
- sourceId: string
- targetId: string
- edgeType: UNION | COMPLETE_UNION | DISJOINT_UNION | COMPLETE_DISJOINT_UNION | INCLUSION | EQUIVALENCE | INSTANCE_OF | INPUT | ATTRIBUTE_EDGE
Returns undefined | GrapholElement
- Defined in src/core/diagram-builder.ts:331

addHierarchy

addHierarchy(hierarchy: Hierarchy, position?: Position): undefined | GrapholElement
Parameters
- hierarchy: Hierarchy
- Optional position: Position
Returns undefined | GrapholElement
- Defined in src/core/diagram-builder.ts:271

addIndividual

addIndividual(individualEntity: GrapholEntity, position?: Position): undefined | GrapholElement
Parameters
- individualEntity: GrapholEntity
- Optional position: Position
Returns undefined | GrapholElement
- Defined in src/core/diagram-builder.ts:245

addObjectProperty

addObjectProperty(objectPropertyEntity: GrapholEntity, sourceEntity: GrapholEntity, targetEntity: GrapholEntity, nodesType: TypesEnum[], objectPropertyElement?: GrapholEdge): undefined | GrapholElement
Add an object property between two entities. If the source and/or target entities are already present in graph, they won't be added again. If there already exists an object property between them with the same IRI, the edge won't be added.

Returns
Parameters
- objectPropertyEntity: GrapholEntity
  
  the object property entity
- sourceEntity: GrapholEntity
  
  the source entity
- targetEntity: GrapholEntity
  
  the target entity
- nodesType: TypesEnum[]
  
  the type of source and target
- Optional objectPropertyElement: GrapholEdge
  
  [optional] to use your own GrapholEdge for the object property occurrence. if you don't pass this, a new GrapholEdge will be created from scratch
Returns undefined | GrapholElement
- Defined in src/core/diagram-builder.ts:107

`Private` addPropertyEdge

addPropertyEdge(propertyEntity: GrapholEntity, sourceEntity: GrapholEntity, targetEntity: GrapholEntity, nodesType: TypesEnum[], propertyType: OBJECT_PROPERTY | ANNOTATION_PROPERTY, propertyEdgeElement?: GrapholEdge): undefined | GrapholElement
Parameters
- propertyEntity: GrapholEntity
- sourceEntity: GrapholEntity
- targetEntity: GrapholEntity
- nodesType: TypesEnum[]
- propertyType: OBJECT_PROPERTY | ANNOTATION_PROPERTY
- Optional propertyEdgeElement: GrapholEdge
Returns undefined | GrapholElement
- Defined in src/core/diagram-builder.ts:140

`Private` getCurrentCenterPos

getCurrentCenterPos(): {
x: number;
y: number;
}
Returns {
x: number;
y: number;
}
- x: number
- y: number
- Defined in src/core/diagram-builder.ts:518

getEntityCyRepr

getEntityCyRepr(entity: GrapholEntity, type: TypesEnum): CollectionReturnValue
Get cytoscape representation of an entity given the type needed

Returns
Parameters
- entity: GrapholEntity
- type: TypesEnum
Returns CollectionReturnValue
- Defined in src/core/diagram-builder.ts:506

getNewId

getNewId(nodeOrEdge: "node" | "edge"): string
Parameters
- nodeOrEdge: "node" | "edge"
Returns string
- Defined in src/core/diagram-builder.ts:514

removeElement

removeElement(id: string): void
Parameters
- id: string
Returns void
- Defined in src/core/diagram-builder.ts:474

removeHierarchy

removeHierarchy(hierarchy: Hierarchy): void
Parameters
- hierarchy: Hierarchy
Returns void
- Defined in src/core/diagram-builder.ts:433

removeHierarchyInclusionEdge

removeHierarchyInclusionEdge(hierarchy: Hierarchy, superclassIri: string): void
Parameters
- hierarchy: Hierarchy
- superclassIri: string
Returns void
- Defined in src/core/diagram-builder.ts:464

removeHierarchyInputEdge

removeHierarchyInputEdge(hierarchy: Hierarchy, inputIri: string): void
Parameters
- hierarchy: Hierarchy
- inputIri: string
Returns void
- Defined in src/core/diagram-builder.ts:454

renameElement

renameElement(elemId: string, newIri: Iri): void
Parameters
- elemId: string
- newIri: Iri
Returns void
- Defined in src/core/diagram-builder.ts:490

swapEdge

swapEdge(elem: EdgeSingular): void
Parameters
- elem: EdgeSingular
Returns void
- Defined in src/core/diagram-builder.ts:422

toggleComplete

toggleComplete(edge: any): void
Parameters
- edge: any
Returns void
- Defined in src/core/diagram-builder.ts:409

toggleFunctionality

toggleFunctionality(entity: GrapholEntity, functional: boolean): void
Parameters
- entity: GrapholEntity
- functional: boolean
Returns void
- Defined in src/core/diagram-builder.ts:374

toggleUnion

toggleUnion(node: any): void
Parameters
- node: any
Returns void
- Defined in src/core/diagram-builder.ts:383

Class DiagramBuilder

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

diagram: Diagram

rendererState: RendererStatesEnum

Returns DiagramBuilder

Properties

diagram

Private rendererState

Accessors

diagramRepresentation

Returns undefined | DiagramRepresentation

Methods

addAnnotationProperty

Returns

Parameters

annotationPropertyEdge: GrapholEntity

sourceEntity: GrapholEntity

targetEntity: GrapholEntity

nodesType: TypesEnum[]

Optional annotationPropertyElement: GrapholEdge

Returns undefined | GrapholElement

addClass

Parameters

classEntity: GrapholEntity

Optional classNode: GrapholNode

Returns GrapholNode

Parameters

classEntity: GrapholEntity

Optional position: Position

Returns GrapholNode

Parameters

classEntity: GrapholEntity

Returns GrapholNode

addDataProperty

Parameters

dataPropertyEntity: GrapholEntity

Optional ownerEntity: GrapholEntity

Returns undefined | GrapholElement

addEdge

Parameters

sourceId: string

targetId: string

edgeType: UNION | COMPLETE_UNION | DISJOINT_UNION | COMPLETE_DISJOINT_UNION | INCLUSION | EQUIVALENCE | INSTANCE_OF | INPUT | ATTRIBUTE_EDGE

Returns undefined | GrapholElement

addHierarchy

Parameters

hierarchy: Hierarchy

Optional position: Position

Returns undefined | GrapholElement

addIndividual

Parameters

individualEntity: GrapholEntity

Optional position: Position

Returns undefined | GrapholElement

addObjectProperty

Returns

Parameters

objectPropertyEntity: GrapholEntity

sourceEntity: GrapholEntity

targetEntity: GrapholEntity

nodesType: TypesEnum[]

Optional objectPropertyElement: GrapholEdge

Returns undefined | GrapholElement

Private addPropertyEdge

Parameters

propertyEntity: GrapholEntity

sourceEntity: GrapholEntity

targetEntity: GrapholEntity

nodesType: TypesEnum[]

propertyType: OBJECT_PROPERTY | ANNOTATION_PROPERTY

Optional propertyEdgeElement: GrapholEdge

Returns undefined | GrapholElement

`Private` rendererState

`Optional` annotationPropertyElement: GrapholEdge

`Optional` classNode: GrapholNode

`Optional` position: Position

`Optional` ownerEntity: GrapholEntity

`Optional` position: Position

`Optional` position: Position

`Optional` objectPropertyElement: GrapholEdge

`Private` addPropertyEdge

`Optional` propertyEdgeElement: GrapholEdge

`Private` getCurrentCenterPos

Returns {
x: number;
y: number;
}