Skip to content

@graphty/graphty-element / catalog / LayoutImplementation

Interface: LayoutImplementation ​

Defined in: graphty-element/src/catalog/layouts.ts:59

One engine that can draw a semantic layout. Plain JSON, like every other descriptor: the engine is named, never referenced.

Properties ​

engine ​

engine: string

Defined in: graphty-element/src/catalog/layouts.ts:61

The registered engine name, exactly as LayoutEngine.getRegisteredTypes reports it.


honoursWeights ​

honoursWeights: boolean

Defined in: graphty-element/src/catalog/layouts.ts:77

Whether this engine arranges a graph differently when its edges carry weights.

Read off the engine class's own static honoursWeights rather than written here, so the catalogue cannot claim a weight channel an engine does not have.


isDefault ​

isDefault: boolean

Defined in: graphty-element/src/catalog/layouts.ts:67

True for the engine the element runs when this layout is asked for by name.


kind ​

kind: "live" | "batch"

Defined in: graphty-element/src/catalog/layouts.ts:64


maxDimensions ​

maxDimensions: 2 | 3

Defined in: graphty-element/src/catalog/layouts.ts:65


options ​

options: readonly OptionDescriptor[]

Defined in: graphty-element/src/catalog/layouts.ts:70


plainName ​

plainName: string

Defined in: graphty-element/src/catalog/layouts.ts:62


reason ​

reason: string

Defined in: graphty-element/src/catalog/layouts.ts:69

Why this engine is the default, or what choosing it over the default buys.


requires? ​

optional requires?: object

Defined in: graphty-element/src/catalog/layouts.ts:89

What has to be true before this engine can run at all, in the same shape an algorithm declares it.

accelerator: true means the engine is computed on hardware and has no processor implementation, so a picker greys the entry out when capabilities.acceleration.state says nothing is attached. It belongs to the ENGINE rather than to the arrangement: force is drawn by six engines, five of which need nothing.

accelerator? ​

optional accelerator?: boolean


scoped ​

scoped: boolean

Defined in: graphty-element/src/catalog/layouts.ts:79

Whether this engine accepts a scope, read off the engine class's own static scoped.


technicalName ​

technicalName: string

Defined in: graphty-element/src/catalog/layouts.ts:63