Class Diagram

Property

diagram's name

Property

diagram's identifier

Hierarchy

Diagram
- IncrementalDiagram
- AnnotationsDiagram

Implements

SwaggerModel.Diagram

Index

Constructors

Properties

id lastViewportState name representations

Methods

addElement clear containsEntity removeElement

Constructors

constructor

new Diagram(name: string, id: number): Diagram
Parameters
- name: string
- id: number
Returns Diagram
- Defined in src/model/diagrams/diagram.ts:23

Properties

id

id: number

Memberof

Diagram

lastViewportState

lastViewportState: Viewport

Memberof

Diagram

name

name: string

Memberof

Diagram

representations

representations: Map<RendererStatesEnum, DiagramRepresentation> = ...

Methods

addElement

addElement(newElement: GrapholElement, grapholEntity?: GrapholEntity): void
Add a new element (node or edge) to the diagram's representation
Parameters
- newElement: GrapholElement
  
  the GrapholElement to add to the diagram
- Optional grapholEntity: GrapholEntity
Returns void
- Defined in src/model/diagrams/diagram.ts:33

clear

clear(rendererState?: RendererStatesEnum): void
Delete every element from a diagram
Parameters
- Optional rendererState: RendererStatesEnum
  
  optional, if you pass a particular rendererState, only its representation will be cleared. If you don't pass any rendererState, all representations will be cleared
Returns void
- Defined in src/model/diagrams/diagram.ts:42

containsEntity

containsEntity(iriOrGrapholEntity: Iri | GrapholEntity, rendererState: RendererStatesEnum): undefined | boolean
Parameters
- iriOrGrapholEntity: Iri | GrapholEntity
- rendererState: RendererStatesEnum
Returns undefined | boolean
- Defined in src/model/diagrams/diagram.ts:52

removeElement

removeElement(elementId: string, rendererState: RendererStatesEnum): void
Parameters
- elementId: string
- rendererState: RendererStatesEnum
Returns void
- Defined in src/model/diagrams/diagram.ts:48