Class: EditorController

Defined in: editor/editorController.tsx:61

Stores, modifies and validates changes from the visual graph authoring (added, deleted or changed graph entities and/or relations).

Properties

Property	Modifier	Type	Description
events	readonly	Events<EditorEvents>	Events for the editor controller.

Accessors

authoringState

Get Signature

get authoringState(): AuthoringState

Defined in: editor/editorController.tsx:155

Graph authoring state snapshot.

Returns

AuthoringState

---

inAuthoringMode

Get Signature

get inAuthoringMode(): boolean

Defined in: editor/editorController.tsx:119

Returns true if the editor is in the graph authoring mode; otherwise false.

Returns

boolean

---

metadataProvider

Get Signature

get metadataProvider(): undefined | MetadataProvider

Defined in: editor/editorController.tsx:141

Provides strategy for the graph authoring mode.

Returns

undefined | MetadataProvider

---

temporaryState

Get Signature

get temporaryState(): TemporaryState

Defined in: editor/editorController.tsx:197

Temporary (transient) state for the graph authoring.

Returns

TemporaryState

---

validationProvider

Get Signature

get validationProvider(): undefined | ValidationProvider

Defined in: editor/editorController.tsx:148

Provides strategy to validate data changes from the graph authoring.

Returns

undefined | ValidationProvider

---

validationState

Get Signature

get validationState(): ValidationState

Defined in: editor/editorController.tsx:181

Validation state snapshot for the data changes from the graph authoring.

Returns

ValidationState

Methods

applyAuthoringChanges()

applyAuthoringChanges(): void

Defined in: editor/editorController.tsx:751

Applies changes from authoringState (including link deletion and entity IRI changes) to the diagram and resets the authoring state to AuthoringState.empty.

The operation puts a command to the command history.

Returns

void

---

changeEntity()

changeEntity(target, newData): void

Defined in: editor/editorController.tsx:384

Changes an existing entity with graph authoring.

If target is specified as an IRI and no entities with that IRI found on the diagram, no changes will be applied to the graph authoring state.

The operation puts a command to the command history.

Parameters

Parameter	Type
target	ElementIri | ElementModel
newData	ElementModel

Returns

void

---

changeRelation()

changeRelation(oldData, newData): void

Defined in: editor/editorController.tsx:495

Changes an existing relation with graph authoring.

The operation puts a command to the command history.

Parameters

Parameter	Type
oldData	LinkModel
newData	LinkModel

Returns

void

---

createEntity()

createEntity(data, options): EntityElement

Defined in: editor/editorController.tsx:354

Creates a new entity with graph authoring.

The operation puts a command to the command history.

Parameters

Parameter	Type
data	ElementModel
options	{ temporary?: boolean; }
options.temporary?	boolean

Returns

EntityElement

---

createRelation()

createRelation(base, options): RelationLink

Defined in: editor/editorController.tsx:454

Creates a new relation with graph authoring.

An error will be thrown if the relation with same identity already exists on the diagram.

The operation puts a command to the command history.

Parameters

Parameter	Type
base	RelationLink
options	{ temporary?: boolean; }
options.temporary?	boolean

Returns

RelationLink

---

deleteEntity()

deleteEntity(target): void

Defined in: editor/editorController.tsx:415

Deletes an existing entity with graph authoring.

If target is specified as an IRI and no entities with that IRI found on the diagram, no changes will be applied to the graph authoring state.

The operation puts a command to the command history.

Parameters

Parameter	Type
target	ElementIri | ElementModel

Returns

void

---

deleteRelation()

deleteRelation(data): void

Defined in: editor/editorController.tsx:578

Deletes an existing relation with graph authoring.

The operation puts a command to the command history.

Parameters

Parameter	Type
data	LinkModel

Returns

void

---

discardChange()

discardChange(event): void

Defined in: editor/editorController.tsx:662

Discards the specified graph authoring event from the state while reverting associated changes to the diagram:

• new entities and links are removed;
• changed entities and links have their data reverted back.

Parameters

Parameter	Type
event	AuthoringEvent

Returns

void

---

moveRelationSource()

moveRelationSource(params): RelationLink

Defined in: editor/editorController.tsx:529

Changes an existing relation with graph authoring by moving its source to another entity element.

The operation puts a command to the command history.

Parameters

Parameter	Type
params	{ link: RelationLink; newSource: EntityElement; }
params.link	RelationLink
params.newSource	EntityElement

Returns

RelationLink

---

moveRelationTarget()

moveRelationTarget(params): RelationLink

Defined in: editor/editorController.tsx:554

Changes an existing relation with graph authoring by moving its target to another entity element.

The operation puts a command to the command history.

Parameters

Parameter	Type
params	{ link: RelationLink; newTarget: EntityElement; }
params.link	RelationLink
params.newTarget	EntityElement

Returns

RelationLink

---

removeAllTemporaryCells()

removeAllTemporaryCells(): void

Defined in: editor/editorController.tsx:603

Removes all diagram cells from the temporary state for the graph authoring.

Returns

void

See

temporaryState

---

removeItems()

removeItems(items): void

Defined in: editor/editorController.tsx:303

Removes the specified diagram cells from the diagram and discards any associated graph authoring state.

If the link is a relation, it will be removed only if it's marked as "added" in the graph authoring state.

The operation puts a command to the command history.

Parameters

Parameter	Type
items	readonly (Element | Link)[]

Returns

void

---

removeSelectedElements()

removeSelectedElements(): void

Defined in: editor/editorController.tsx:285

Removes all selected diagram elements from the diagram and discards any associated graph authoring state.

The operation puts a command to the command history.

Returns

void

---

removeTemporaryCells()

removeTemporaryCells(cells): void

Defined in: editor/editorController.tsx:633

Removes the specified diagram cells from the temporary state for the graph authoring.

Parameters

Parameter	Type
cells	readonly (Element | Link)[]

Returns

void

See

temporaryState

---

revalidateEntities()

revalidateEntities(entities): void

Defined in: editor/editorController.tsx:264

Forces re-validation for the specified entities.

Parameters

Parameter	Type
entities	ReadonlySet<ElementIri>

Returns

void

---

setAuthoringMode()

setAuthoringMode(value): void

Defined in: editor/editorController.tsx:128

Toggles the graph authoring mode for the editor.

Does nothing if metadataProvider is not set.

Parameters

Parameter	Type
value	boolean

Returns

void

---

setAuthoringState()

setAuthoringState(value): void

Defined in: editor/editorController.tsx:163

Sets graph authoring state.

The operation puts a command to the command history.

Parameters

Parameter	Type
value	AuthoringState

Returns

void

---

setTemporaryState()

setTemporaryState(value): void

Defined in: editor/editorController.tsx:203

Sets temporary (transient) state for the graph authoring.

Parameters

Parameter	Type
value	TemporaryState

Returns

void

---

setValidationState()

setValidationState(value): void

Defined in: editor/editorController.tsx:187

Sets validation state for the data changes from the graph authoring.

Parameters

Parameter	Type
value	ValidationState

Returns

void