ElementProxy

An element is anything on a Lucid document that can have properties and shape data:

• The document itself
• Pages
• Blocks
• Lines
• Groups

Extends

• PropertyStoreProxy

Extended by

• DocumentProxy
• ItemProxy
• PageProxy

---

Constructors

new ElementProxy()

ts

new ElementProxy(id, client): ElementProxy

Parameters

Parameter	Type	Description
id	string	ID of this element
client	EditorClient

Returns

ElementProxy

Overrides

PropertyStoreProxy.constructor

---

Properties

allShapeData

ts

readonly allShapeData: MapProxy<string, SerializedFieldType | DataError>;

All shape data accessible on this element, including shape data inherited from the page or a containing group.
This collection is read-only.

---

client

ts

protected readonly client: EditorClient;

Inherited from

PropertyStoreProxy.client

---

id

ts

readonly id: string;

ID of this element

Inherited from

PropertyStoreProxy.id

---

properties

ts

readonly properties: WriteableMapProxy<string, JsonSerializable, void, JsonSerializable>;

All properties available on this element, organized by name.
Not all properties are writeable (e.g. "ClassName" on a block).
To move or resize elements, use setLocation() or setBoundingBox() or offset() instead.

Inherited from

PropertyStoreProxy.properties

---

referenceKeys

ts

readonly referenceKeys: MapProxy<string | number, ReferenceKeyProxy>;

The set of reference keys, organized by their ID, which can be either a string or number.

For more information, see the Developer Guide.

---

shapeData

ts

readonly shapeData: ShapeDataProxy;

The shape data set directly on this element (not including any shape data inherited from the page or a containing group).

---

Methods

executeFormula()

ts

executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Parameter	Type	Description
formula	string	The formula text, e.g. "@a + @b" to add together the shape data values a and b.

Returns

SerializedFieldType | DataError

The result of the formula, or an error.

---

exists()

ts

exists(): boolean

Returns

boolean

true if this element still exists on the document, or false otherwise

---

removeReferenceKey()

ts

removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Parameter	Type	Description
key	string | number

Returns

void

---

setReferenceKey()

ts

setReferenceKey(key, settings): void

Set a reference key on this element, replacing any existing reference at the specified key.

Parameters

Parameter	Type	Description
key	string | number
settings	ReferenceKeyDefinition

Returns

void