Interface: RenderingState

Defined in: diagram/renderingState.ts:126

Stores current rendering state for a single canvas.

Extends

• SizeProvider

Properties

Property	Modifier	Type	Description
events	readonly	Events<RenderingStateEvents>	Events for the rendering state.
shared	readonly	SharedCanvasState	Shared state for all canvases rendering the same model.

Methods

getElementShape()

getElementShape(element): ShapeGeometry

Defined in: diagram/geometry.ts:151

Gets element shape based on its template and the current bounds.

Parameters

Parameter	Type
element	Element

Returns

ShapeGeometry

Inherited from

SizeProvider.getElementShape

---

getElementSize()

getElementSize(element): undefined | Size

Defined in: diagram/renderingState.ts:156

Returns computed element size in paper coordinates.

Parameters

Parameter	Type
element	Element

Returns

undefined | Size

Overrides

SizeProvider.getElementSize

---

getElementTemplate()

getElementTemplate(element): ElementTemplate

Defined in: diagram/renderingState.ts:164

Resolve template component for the element.

Parameters

Parameter	Type
element	Element

Returns

ElementTemplate

---

getLinkLabelBounds()

getLinkLabelBounds(link): undefined | Rect

Defined in: diagram/renderingState.ts:160

Returns computed bounds for a link primary label in paper coordinates.

Parameters

Parameter	Type
link	Link

Returns

undefined | Rect

---

getLinkTemplates()

getLinkTemplates(): ReadonlyMap<LinkTypeIri, LinkTemplate>

Defined in: diagram/renderingState.ts:168

Returns link templates for all types of rendered links.

Returns

ReadonlyMap<LinkTypeIri, LinkTemplate>

---

getRouting()

getRouting(linkId): undefined | RoutedLink

Defined in: diagram/renderingState.ts:176

Return route data for a specific link in the graph.

Parameters

Parameter	Type
linkId	string

Returns

undefined | RoutedLink

---

getRoutings()

getRoutings(): ReadonlyMap<string, RoutedLink>

Defined in: diagram/renderingState.ts:172

Returns route data for all links in the graph.

Returns

ReadonlyMap<string, RoutedLink>

---

syncUpdate()

syncUpdate(): void

Defined in: diagram/renderingState.ts:152

Request to synchronously render the canvas, performing any previously deferred updates.

This method should be used before reading from the rendering state after any render-impacting change was made to the diagram content.

Example:

// Add new element to the diagram
model.addElement(someElement);
// Force synchronous render
view.syncUpdate();
// Read rendered element size
const computedSize = view.getElementSize(someElement);

Returns

void