Skip to main content

Interface: DataGraphStructure

Provides entity graph content: elements and connected links, as well as element, link and property types.

Extends

Accessors

elements

get elements(): readonly Element[]

All elements (nodes) in the graph.

Returns

readonly Element[]

Inherited from

GraphStructure.elements

Defined in

diagram/model.ts:69


factory

get factory(): DataFactory

Provides an RDF term factory to create RDF terms for identifiers and property values.

Returns

DataFactory

Inherited from

GraphStructure.factory

Defined in

diagram/model.ts:65


get links(): readonly Link[]

All links (edges) between elements in the graph.

Returns

readonly Link[]

Inherited from

GraphStructure.links

Defined in

diagram/model.ts:73

Methods

findLink(linkTypeId, sourceId, targetId): undefined | Link

Searches for any link of the specified type between elements with specified IDs in the graph if exists.

If multiple links is found, any of them could be returned.

Parameters

ParameterType

linkTypeId

LinkTypeIri

sourceId

string

targetId

string

Returns

undefined | Link

Inherited from

GraphStructure.findLink

Defined in

diagram/model.ts:94


getElement()

getElement(elementId): undefined | Element

Gets an element by its Element.id in the graph if exists.

Parameters

ParameterType

elementId

string

Returns

undefined | Element

Inherited from

GraphStructure.getElement

Defined in

diagram/model.ts:77


getElementLinks(element): readonly Link[]

Gets all links connected to the specified element in the graph.

If element is not in the graph, no links would be returned.

Parameters

ParameterType

element

Element

Returns

readonly Link[]

Inherited from

GraphStructure.getElementLinks

Defined in

diagram/model.ts:83


getElementType()

getElementType(elementTypeIri): undefined | ElementType

Gets an element type by its ElementType.id in the graph if exists.

Element types are added to the graph as requested by DataDiagramModel.createElementType so the data (e.g. labels) can be fetched from a data provider.

Parameters

ParameterType

elementTypeIri

ElementTypeIri

Returns

undefined | ElementType

See

DataDiagramModel.createElementType

Defined in

editor/dataDiagramModel.ts:115


getLink(linkId): undefined | Link

Gets a link by its Link.id in the graph if exists.

Parameters

ParameterType

linkId

string

Returns

undefined | Link

Inherited from

GraphStructure.getLink

Defined in

diagram/model.ts:87


getLinkType()

getLinkType(linkTypeIri): undefined | LinkType

Gets an link type by its LinkType.id in the graph if exists.

Link types are added to the graph as requested by DataDiagramModel.createLinkType so the data (e.g. labels) can be fetched from a data provider.

Parameters

ParameterType

linkTypeIri

LinkTypeIri

Returns

undefined | LinkType

See

DataDiagramModel.createLinkType

Defined in

editor/dataDiagramModel.ts:124


getLinkVisibility()

getLinkVisibility(linkTypeId): LinkTypeVisibility

Gets current visibility mode for the specified link type.

Parameters

ParameterType

linkTypeId

LinkTypeIri

Returns

LinkTypeVisibility

Inherited from

GraphStructure.getLinkVisibility

Defined in

diagram/model.ts:110


getPropertyType()

getPropertyType(propertyTypeIri): undefined | PropertyType

Gets an property type by its PropertyType.id in the graph if exists.

Property types are added to the graph as requested by DataDiagramModel.createPropertyType so the data (e.g. labels) can be fetched from a data provider.

Parameters

ParameterType

propertyTypeIri

PropertyTypeIri

Returns

undefined | PropertyType

See

DataDiagramModel.createPropertyType

Defined in

editor/dataDiagramModel.ts:134


sourceOf()

sourceOf(link): undefined | Element

Gets a source element for the specified link in the graph.

If link is not in the graph, undefined would be returned instead.

Parameters

ParameterType

link

Link

Returns

undefined | Element

Inherited from

GraphStructure.sourceOf

Defined in

diagram/model.ts:100


targetOf()

targetOf(link): undefined | Element

Gets a target element for the specified link in the graph.

If link is not in the graph, undefined would be returned instead.

Parameters

ParameterType

link

Link

Returns

undefined | Element

Inherited from

GraphStructure.targetOf

Defined in

diagram/model.ts:106