rune-langium / visual-editor/src / CommonFormActions

Interface: CommonFormActions

Defined in: packages/visual-editor/src/types.ts:220

Actions shared by all type kinds.

Extends

• Partial<InspectorMetadataActions>

Extended by

• DataFormActions
• EnumFormActions
• ChoiceFormActions
• FuncFormActions
• TypeAliasFormActions

Properties

Property	Type	Inherited from	Defined in
applyMetadataCommand?	(target, command) => MetadataEditResult	Partial.applyMetadataCommand	packages/visual-editor/src/store/metadata-target.ts:76
captureMetadataTarget?	(nodeId, path) => MetadataTarget | undefined	Partial.captureMetadataTarget	packages/visual-editor/src/store/metadata-target.ts:75

Methods

addAnnotation()

addAnnotation(nodeId, annotationName): void;

Defined in: packages/visual-editor/src/types.ts:227

Parameters

Parameter	Type
nodeId	string
annotationName	string

Returns

void

---

addCondition()

addCondition(nodeId, condition): void;

Defined in: packages/visual-editor/src/types.ts:229

Parameters

Parameter	Type
nodeId	string
condition	{ definition?: string; expressionText: string; isPostCondition?: boolean; name?: string; }
condition.definition?	string
condition.expressionText	string
condition.isPostCondition?	boolean
condition.name?	string

Returns

void

---

addSynonym()

addSynonym(
   nodeId, 
   source, 
   value?
): void;

Defined in: packages/visual-editor/src/types.ts:225

Parameters

Parameter	Type
nodeId	string
source	string
value?	string

Returns

void

---

deleteType()

deleteType(nodeId): void;

Defined in: packages/visual-editor/src/types.ts:222

Parameters

Parameter	Type
nodeId	string

Returns

void

---

removeAnnotation()

removeAnnotation(nodeId, index): void;

Defined in: packages/visual-editor/src/types.ts:228

Parameters

Parameter	Type
nodeId	string
index	number

Returns

void

---

removeCondition()

removeCondition(nodeId, index): void;

Defined in: packages/visual-editor/src/types.ts:238

Parameters

Parameter	Type
nodeId	string
index	number

Returns

void

---

removeSynonym()

removeSynonym(nodeId, index): void;

Defined in: packages/visual-editor/src/types.ts:226

Parameters

Parameter	Type
nodeId	string
index	number

Returns

void

---

renameType()

renameType(nodeId, newName): void;

Defined in: packages/visual-editor/src/types.ts:221

Parameters

Parameter	Type
nodeId	string
newName	string

Returns

void

---

reorderCondition()

reorderCondition(
   nodeId, 
   fromIndex, 
   toIndex
): void;

Defined in: packages/visual-editor/src/types.ts:248

Parameters

Parameter	Type
nodeId	string
fromIndex	number
toIndex	number

Returns

void

---

updateComments()

updateComments(nodeId, comments): void;

Defined in: packages/visual-editor/src/types.ts:224

Parameters

Parameter	Type
nodeId	string
comments	string

Returns

void

---

updateCondition()

updateCondition(
   nodeId, 
   index, 
   updates
): void;

Defined in: packages/visual-editor/src/types.ts:239

Parameters

Parameter	Type
nodeId	string
index	number
updates	{ definition?: string; expressionText?: string; name?: string; }
updates.definition?	string
updates.expressionText?	string
updates.name?	string

Returns

void

---

updateDefinition()

updateDefinition(nodeId, definition): void;

Defined in: packages/visual-editor/src/types.ts:223

Parameters

Parameter	Type
nodeId	string
definition	string

Returns

void

---

validate()

validate(): ValidationError[];

Defined in: packages/visual-editor/src/types.ts:249

Returns

ValidationError[]