Class IncrementalController

Hierarchy

IncrementalBase
- IncrementalController

Constructors

constructor

new IncrementalController(grapholscape: Grapholscape): IncrementalController
Parameters
- grapholscape: Grapholscape
Returns IncrementalController
Overrides IncrementalBase.constructor
- Defined in src/incremental/controller.ts:20

Properties

`Protected` actionsWithBlockedGraph

actionsWithBlockedGraph: number = 0

classFilterMap

classFilterMap: Map<string, Filter> = ...

diagram

diagram: IncrementalDiagram = ...

diagramBuilder

diagramBuilder: DiagramBuilder

grapholscape

grapholscape: Grapholscape

`Private` individualsButton

individualsButton: NodeButton

lifecycle

lifecycle: default = ...

`Private` neighbourhoodFinder

neighbourhoodFinder: NeighbourhoodFinder

`Private` objectPropertyButton

objectPropertyButton: NodeButton

on

on: IonIncrementalEvent = ...

Accessors

`Private` incrementalRenderer

get incrementalRenderer(): undefined | IncrementalRendererState
Returns undefined | IncrementalRendererState
Inherited from IncrementalBase.incrementalRenderer
- Defined in src/incremental/i-incremental.ts:419

numberOfElements

get numberOfElements(): number
Returns number
Inherited from IncrementalBase.numberOfElements
- Defined in src/incremental/i-incremental.ts:425

Methods

addClass

addClass(iri: string, centerOnIt?: boolean, position?: Position): undefined | GrapholNode
Parameters
- iri: string
- centerOnIt: boolean = true
- Optional position: Position
Returns undefined | GrapholNode
Inherited from IncrementalBase.addClass
- Defined in src/incremental/i-incremental.ts:102

addEdge

addEdge(sourceId: string, targetId: string, edgeType: INCLUSION | EQUIVALENCE | INSTANCE_OF | INPUT): undefined | GrapholElement
Parameters
- sourceId: string
- targetId: string
- edgeType: INCLUSION | EQUIVALENCE | INSTANCE_OF | INPUT
Returns undefined | GrapholElement
Inherited from IncrementalBase.addEdge
- Defined in src/incremental/i-incremental.ts:89

addIndividual

addIndividual(individual: GrapholEntity, parentClassesIris?: string[], position?: Position): undefined | GrapholElement
Parameters
- individual: GrapholEntity
- Optional parentClassesIris: string[]
- Optional position: Position
Returns undefined | GrapholElement
Inherited from IncrementalBase.addIndividual
- Defined in src/incremental/i-incremental.ts:132

addIntensionalObjectProperty

addIntensionalObjectProperty(objectPropertyIri: string, sourceClassIri: string, targetClassIri: string): undefined | GrapholEdge
Add object property edge between two classes.
Parameters
- objectPropertyIri: string
  
  the object property iri to add
- sourceClassIri: string
- targetClassIri: string
Returns undefined | GrapholEdge
Inherited from IncrementalBase.addIntensionalObjectProperty
- Defined in src/incremental/i-incremental.ts:160

getAnnotations

getAnnotations(iri: string): Promise<Annotation[]>
Parameters
- iri: string
Returns Promise<Annotation[]>
Overrides IncrementalBase.getAnnotations
- Defined in src/incremental/controller.ts:43

getContextMenuCommands

getContextMenuCommands(grapholElement: GrapholElement, cyElement: SingularElementReturnValue): Command[]
Parameters
- grapholElement: GrapholElement
- cyElement: SingularElementReturnValue
Returns Command[]
Overrides IncrementalBase.getContextMenuCommands
- Defined in src/incremental/controller.ts:82

getDataPropertiesHighlights

getDataPropertiesHighlights(iris: string[], _isInstance: boolean): Promise<GrapholEntity[]>
Parameters
- iris: string[]
- _isInstance: boolean
Returns Promise<GrapholEntity[]>
Overrides IncrementalBase.getDataPropertiesHighlights
- Defined in src/incremental/controller.ts:31

getHighlights

getHighlights(iris: string[], isInstance: boolean): Promise<IncrementalHighlights>
Parameters
- iris: string[]
- isInstance: boolean
Returns Promise<IncrementalHighlights>
Overrides IncrementalBase.getHighlights
- Defined in src/incremental/controller.ts:27

getIDByIRI

getIDByIRI(iri: string, type: TypesEnum): undefined | string
Parameters
- iri: string
- type: TypesEnum
Returns undefined | string
Inherited from IncrementalBase.getIDByIRI
- Defined in src/incremental/i-incremental.ts:412

getNodeButtons

getNodeButtons(grapholElement: GrapholElement): NodeButton[]
Parameters
- grapholElement: GrapholElement
Returns NodeButton[]
Overrides IncrementalBase.getNodeButtons
- Defined in src/incremental/controller.ts:230

getObjectPropertiesHighlights

getObjectPropertiesHighlights(iris: string[], isInstance: boolean): Promise<Map<GrapholEntity, ObjectPropertyConnectedClasses>>
Parameters
- iris: string[]
- isInstance: boolean
Returns Promise<Map<GrapholEntity, ObjectPropertyConnectedClasses>>
Overrides IncrementalBase.getObjectPropertiesHighlights
- Defined in src/incremental/controller.ts:37

getSubClasses

getSubClasses(classIri: string): Promise<GrapholEntity[]>
Parameters
- classIri: string
Returns Promise<GrapholEntity[]>
Overrides IncrementalBase.getSubClasses
- Defined in src/incremental/controller.ts:68

getSuperClasses

getSuperClasses(classIri: string): Promise<GrapholEntity[]>
Parameters
- classIri: string
Returns Promise<GrapholEntity[]>
Overrides IncrementalBase.getSuperClasses
- Defined in src/incremental/controller.ts:54

init

init(): void
Returns void
Overrides IncrementalBase.init
- Defined in src/incremental/controller.ts:216

`Private` initNodeButtons

initNodeButtons(): void
Returns void
- Defined in src/incremental/controller.ts:222

`Protected` isHierarchyNodeInDiagram

isHierarchyNodeInDiagram(hierarchy: Hierarchy): undefined | boolean
Parameters
- hierarchy: Hierarchy
Returns undefined | boolean
Inherited from IncrementalBase.isHierarchyNodeInDiagram
- Defined in src/incremental/i-incremental.ts:408

performActionWithBlockedGraph

performActionWithBlockedGraph(action: (() => void | Promise<void>), customLayoutOptions?: any): Promise<void>
Parameters
- action: (() => void | Promise<void>)
  - - (): void | Promise<void>
    - Returns void | Promise<void>
- Optional customLayoutOptions: any
Returns Promise<void>
Inherited from IncrementalBase.performActionWithBlockedGraph
- Defined in src/incremental/i-incremental.ts:80

postDiagramEdit

postDiagramEdit(oldElemsNumber: number, customLayoutOptions?: any): void
Parameters
- oldElemsNumber: number
- Optional customLayoutOptions: any
Returns void
Inherited from IncrementalBase.postDiagramEdit
- Defined in src/incremental/i-incremental.ts:395

removeEntity

removeEntity(entity: GrapholEntity, entitiesIrisToKeep?: string[]): void
Remove a class, an instance or a data property node from the diagram. Entities left with no other connections are recurisvely removed too. Called when the user click on the remove button on a entity node
Parameters
- entity: GrapholEntity
- entitiesIrisToKeep: string[] = []
Returns void
Inherited from IncrementalBase.removeEntity
- Defined in src/incremental/i-incremental.ts:331

removeHierarchy

removeHierarchy(hierarchy: Hierarchy, entitiesTokeep?: string[]): void
Parameters
- hierarchy: Hierarchy
- entitiesTokeep: string[] = []
Returns void
Inherited from IncrementalBase.removeHierarchy
- Defined in src/incremental/i-incremental.ts:296

reset

reset(): void
Returns void
Overrides IncrementalBase.reset
- Defined in src/incremental/controller.ts:256

setIncrementalEventHandlers

setIncrementalEventHandlers(): void
Returns void
Overrides IncrementalBase.setIncrementalEventHandlers
- Defined in src/incremental/controller.ts:238

showClassesInIsa

showClassesInIsa(sourceIri: string, targetsIris: string[], isaType: INCLUSION | EQUIVALENCE, subOrSuper?: "sub" | "super"): void
Parameters
- sourceIri: string
- targetsIris: string[]
- isaType: INCLUSION | EQUIVALENCE
- subOrSuper: "sub" | "super" = 'sub'
Returns void
Inherited from IncrementalBase.showClassesInIsa
- Defined in src/incremental/i-incremental.ts:194

showDiagram

showDiagram(viewportState?: Viewport): void
Parameters
- Optional viewportState: Viewport
Returns void
Inherited from IncrementalBase.showDiagram
- Defined in src/incremental/i-incremental.ts:93

`Protected` showOrHideHierarchies

showOrHideHierarchies(classIri: string, hierarchyType: "sub" | "any" | "super", showORHide: "hide" | "show"): void
Parameters
- classIri: string
- hierarchyType: "sub" | "any" | "super"
- showORHide: "hide" | "show"
Returns void
Inherited from IncrementalBase.showOrHideHierarchies
- Defined in src/incremental/i-incremental.ts:253

showSubHierarchiesOf

showSubHierarchiesOf(classIri: string): void
Show hierarchies for which the specified class is a superclass.
Parameters
- classIri: string
Returns void
Inherited from IncrementalBase.showSubHierarchiesOf
- Defined in src/incremental/i-incremental.ts:249

showSuperHierarchiesOf

showSuperHierarchiesOf(classIri: string): void
Show hierarchies for which the specified class is a subclass.
Parameters
- classIri: string
Returns void
Inherited from IncrementalBase.showSuperHierarchiesOf
- Defined in src/incremental/i-incremental.ts:241

Class IncrementalController

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

grapholscape: Grapholscape

Returns IncrementalController

Properties

Protected actionsWithBlockedGraph

classFilterMap

diagram

diagramBuilder

grapholscape

Private individualsButton

lifecycle

Private neighbourhoodFinder

Private objectPropertyButton

on

Accessors

Private incrementalRenderer

Returns undefined | IncrementalRendererState

numberOfElements

Returns number

Methods

addClass

Parameters

iri: string

centerOnIt: boolean = true

Optional position: Position

Returns undefined | GrapholNode

addEdge

Parameters

sourceId: string

targetId: string

edgeType: INCLUSION | EQUIVALENCE | INSTANCE_OF | INPUT

Returns undefined | GrapholElement

addIndividual

Parameters

individual: GrapholEntity

Optional parentClassesIris: string[]

Optional position: Position

Returns undefined | GrapholElement

addIntensionalObjectProperty

Parameters

objectPropertyIri: string

sourceClassIri: string

targetClassIri: string

Returns undefined | GrapholEdge

getAnnotations

Parameters

iri: string

Returns Promise<Annotation[]>

getContextMenuCommands

Parameters

grapholElement: GrapholElement

cyElement: SingularElementReturnValue

Returns Command[]

getDataPropertiesHighlights

Parameters

iris: string[]

_isInstance: boolean

Returns Promise<GrapholEntity[]>

getHighlights

Parameters

iris: string[]

isInstance: boolean

Returns Promise<IncrementalHighlights>

getIDByIRI

Parameters

iri: string

type: TypesEnum

Returns undefined | string

getNodeButtons

Parameters

grapholElement: GrapholElement

`Protected` actionsWithBlockedGraph

`Private` individualsButton

`Private` neighbourhoodFinder

`Private` objectPropertyButton

`Private` incrementalRenderer

`Optional` position: Position

`Optional` parentClassesIris: string[]

`Optional` position: Position

`Private` initNodeButtons

`Protected` isHierarchyNodeInDiagram

`Optional` customLayoutOptions: any

`Optional` customLayoutOptions: any

`Optional` viewportState: Viewport

`Protected` showOrHideHierarchies