Skip to main content

Interface: RenderingState

Stores current rendering state for a single canvas.

Extends

Properties

PropertyModifierTypeDescription

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

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

Parameters

ParameterType

element

Element

Returns

ShapeGeometry

Inherited from

SizeProvider.getElementShape

Defined in

diagram/geometry.ts:151


getElementSize()

getElementSize(element): undefined | Size

Returns computed element size in paper coordinates.

Parameters

ParameterType

element

Element

Returns

undefined | Size

Overrides

SizeProvider.getElementSize

Defined in

diagram/renderingState.ts:151


getElementTemplate()

getElementTemplate(element): ElementTemplate

Resolve template component for the element.

Parameters

ParameterType

element

Element

Returns

ElementTemplate

Defined in

diagram/renderingState.ts:159


getLinkLabelBounds()

getLinkLabelBounds(link): undefined | Rect

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

Parameters

ParameterType

link

Link

Returns

undefined | Rect

Defined in

diagram/renderingState.ts:155


getLinkTemplates()

getLinkTemplates(): ReadonlyMap<LinkTypeIri, LinkTemplate>

Returns link templates for all types of rendered links.

Returns

ReadonlyMap<LinkTypeIri, LinkTemplate>

Defined in

diagram/renderingState.ts:163


getRouting()

getRouting(linkId): undefined | RoutedLink

Return route data for a specific link in the graph.

Parameters

ParameterType

linkId

string

Returns

undefined | RoutedLink

Defined in

diagram/renderingState.ts:171


getRoutings()

getRoutings(): ReadonlyMap<string, RoutedLink>

Returns route data for all links in the graph.

Returns

ReadonlyMap<string, RoutedLink>

Defined in

diagram/renderingState.ts:167


syncUpdate()

syncUpdate(): void

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

Defined in

diagram/renderingState.ts:147