Skip to content

@graphty/graphty-element / session / LayoutRecommendation

Interface: LayoutRecommendation ​

Defined in: graphty-element/src/session/layout.ts:31

Which arrangement suits this graph, and why.

Properties ​

layout ​

readonly layout: LayoutDescriptor

Defined in: graphty-element/src/session/layout.ts:39

The arrangement, exactly as catalog.layouts() publishes it.

layout.id is the public arrangement name -- "force", "circular" -- and layout.engine is the registered engine that runs it by default. setLayout takes either, so a consumer acts on the id: element.setLayout(recommendation.layout.id).


reason ​

readonly reason: string

Defined in: graphty-element/src/session/layout.ts:41

Why this arrangement suits this graph, in a sentence a consumer can show a reader.