Class: EntityElement

Defined in: src/editor/dataElements.ts:54

Data graph entity represented by a diagram element and referenced by an IRI.

Extends

• Element

Constructors

Constructor

new EntityElement(props): EntityElement

Defined in: src/editor/dataElements.ts:59

Parameters

Parameter	Type
props	EntityElementProps

Returns

EntityElement

Overrides

Element.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from
events	readonly	Events<EntityElementEvents>	undefined	Events for the graph element.	Element.events	‐
id	readonly	string	undefined	Unique and immutable element ID on the diagram.	‐	Element.id
fromJSONType	readonly	"Element"	'Element'	‐	‐	‐

Accessors

data

Get Signature

get data(): ElementModel

Defined in: src/editor/dataElements.ts:104

Returns

ElementModel

---

elementState

Get Signature

get elementState(): TemplateState

Defined in: src/diagram/elements.ts:195

Gets a serializable template-specific state for the element.

Returns

TemplateState

Inherited from

Element.elementState

---

iri

Get Signature

get iri(): ElementIri

Defined in: src/editor/dataElements.ts:102

Returns

ElementIri

---

isExpanded

Get Signature

get isExpanded(): boolean

Defined in: src/diagram/elements.ts:173

Whether the element should be displayed as expanded (as defined by the element template).

Expanded state is stored in the element state with TemplateProperties.Expanded property.

Returns

boolean

Inherited from

Element.isExpanded

---

position

Get Signature

get position(): Vector

Defined in: src/diagram/elements.ts:143

Gets the element position on the canvas in paper coordinates.

Returns

Vector

Inherited from

Element.position

Methods

focus()

focus(): void

Defined in: src/diagram/elements.ts:215

Focuses on the element template on a canvas (if possible).

Returns

void

Inherited from

Element.focus

---

redraw()

redraw(level?): void

Defined in: src/diagram/elements.ts:224

Forces a re-render of the element displayed by a template on a canvas.

Parameters

Parameter	Type	Description
level?	ElementRedrawLevel	specifies which cached state should be invalidated on re-render

Returns

void

Inherited from

Element.redraw

---

setData()

setData(value): void

Defined in: src/editor/dataElements.ts:107

Parameters

Parameter	Type
value	ElementModel

Returns

void

---

setElementState()

setElementState(value): void

Defined in: src/diagram/elements.ts:205

Sets a new value for elementState property.

Triggers ElementEvents.changeElementState event if new value does not equal to the previous one.

Parameters

Parameter	Type
value	TemplateState

Returns

void

Inherited from

Element.setElementState

---

setExpanded()

setExpanded(value): void

Defined in: src/diagram/elements.ts:186

Sets a new value for isExpanded property.

Expanded state is stored in the element state with TemplateProperties.Expanded property.

Triggers ElementEvents.changeElementState event if new value does not equal to the previous one.

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

Element.setExpanded

---

setPosition()

setPosition(value): void

Defined in: src/diagram/elements.ts:155

Sets a new value for position property.

Triggers ElementEvents.changePosition event if new value does not equal to the previous one.

Parameters

Parameter	Type
value	Vector

Returns

void

See

RestoreGeometry

Inherited from

Element.setPosition

---

toJSON()

toJSON(): SerializedEntityElement

Defined in: src/editor/dataElements.ts:137

Returns

SerializedEntityElement

---

fromJSON()

static fromJSON(state, options): undefined | EntityElement

Defined in: src/editor/dataElements.ts:117

Parameters

Parameter	Type
state	SerializedEntityElement
options	ElementFromJsonOptions

Returns

undefined | EntityElement

---

generateId()

static generateId(): string

Defined in: src/diagram/elements.ts:136

Generates a new unique ID for an element.

Returns

string

Inherited from

Element.generateId

---

isPlaceholderData()

static isPlaceholderData(data): boolean

Defined in: src/editor/dataElements.ts:91

Returns true if the data is an empty placeholder (not yet loaded) data, otherwise false.

The entity data is considered to be a placeholder data if data.properties contains PlaceholderDataProperty key with a empty or non-empty values.

Parameters

Parameter	Type
data	ElementModel

Returns

boolean

See

PlaceholderDataProperty

---

placeholderData()

static placeholderData(iri): ElementModel

Defined in: src/editor/dataElements.ts:72

Creates an empty (placeholder) data for the specified entity IRI.

This data can be used to display an entity in the UI until the actual data is loaded from a data provider.

Parameters

Parameter	Type
iri	ElementIri

Returns

ElementModel

See

PlaceholderDataProperty