Interface: MetadataProvider

Defined in: src/data/metadataProvider.ts:20

Provides a strategy to visual graph authoring: which parts of the graph are editable and what is the range of possible values to allow.

Unstable: this interface will likely change in the future.

It is recommended to extend BaseMetadataProvider instead of implementing this interface directly to stay compatible with future versions.

Methods

canConnect()

canConnect(source, target, linkType, options): Promise<MetadataCanConnect[]>

Defined in: src/data/metadataProvider.ts:35

Parameters

Parameter	Type
source	ElementModel
target	undefined | ElementModel
linkType	undefined | LinkTypeIri
options	{ signal?: AbortSignal; }
options.signal?	AbortSignal

Returns

Promise<MetadataCanConnect[]>

---

canModifyEntity()

canModifyEntity(entity, options): Promise<MetadataCanModifyEntity>

Defined in: src/data/metadataProvider.ts:42

Parameters

Parameter	Type
entity	ElementModel
options	{ signal?: AbortSignal; }
options.signal?	AbortSignal

Returns

Promise<MetadataCanModifyEntity>

---

canModifyRelation()

canModifyRelation(link, source, target, options): Promise<MetadataCanModifyRelation>

Defined in: src/data/metadataProvider.ts:47

Parameters

Parameter	Type
link	LinkModel
source	ElementModel
target	ElementModel
options	{ signal?: AbortSignal; }
options.signal?	AbortSignal

Returns

Promise<MetadataCanModifyRelation>

---

createEntity()

createEntity(type, options): Promise<MetadataCreatedEntity>

Defined in: src/data/metadataProvider.ts:23

Parameters

Parameter	Type
type	ElementTypeIri
options	MetadataCreateOptions

Returns

Promise<MetadataCreatedEntity>

---

createRelation()

createRelation(source, target, linkType, options): Promise<MetadataCreatedRelation>

Defined in: src/data/metadataProvider.ts:28

Parameters

Parameter	Type
source	ElementModel
target	ElementModel
linkType	LinkTypeIri
options	MetadataCreateOptions

Returns

Promise<MetadataCreatedRelation>

---

filterConstructibleTypes()

filterConstructibleTypes(types, options): Promise<ReadonlySet<ElementTypeIri>>

Defined in: src/data/metadataProvider.ts:66

Parameters

Parameter	Type
types	ReadonlySet<ElementTypeIri>
options	{ signal?: AbortSignal; }
options.signal?	AbortSignal

Returns

Promise<ReadonlySet<ElementTypeIri>>

---

getEntityShape()

getEntityShape(types, options): Promise<MetadataEntityShape>

Defined in: src/data/metadataProvider.ts:54

Parameters

Parameter	Type
types	readonly ElementTypeIri[]
options	{ signal?: AbortSignal; }
options.signal?	AbortSignal

Returns

Promise<MetadataEntityShape>

---

getLiteralLanguages()

getLiteralLanguages(): readonly string[]

Defined in: src/data/metadataProvider.ts:21

Returns

readonly string[]

---

getRelationShape()

getRelationShape(linkType, source, target, options): Promise<MetadataRelationShape>

Defined in: src/data/metadataProvider.ts:59

Parameters

Parameter	Type
linkType	LinkTypeIri
source	ElementModel
target	ElementModel
options	{ signal?: AbortSignal; }
options.signal?	AbortSignal

Returns

Promise<MetadataRelationShape>