@graphty/graphty-element / catalog / LayoutDescriptor
Interface: LayoutDescriptor ​
Defined in: graphty-element/src/catalog/types.ts:729
One layout the element can place a graph with.
Properties ​
description ​
description:
string
Defined in: graphty-element/src/catalog/types.ts:733
engine ​
engine:
string
Defined in: graphty-element/src/catalog/types.ts:741
The implementation behind this layout.
family ​
family:
string
Defined in: graphty-element/src/catalog/types.ts:734
honoursWeights ​
honoursWeights:
boolean
Defined in: graphty-element/src/catalog/types.ts:750
Whether the default engine arranges this graph differently when its edges carry weights.
A picker reads it to know which arrangements the weighted option actually does something for. Of the element's own sixteen engines only Kamada-Kawai and ForceAtlas2 answer true; offering a weight control on the other fourteen would advertise a setting that changes nothing.
id ​
id:
LayoutId
Defined in: graphty-element/src/catalog/types.ts:730
kind ​
kind:
"live"|"batch"
Defined in: graphty-element/src/catalog/types.ts:735
maxDimensions ​
maxDimensions:
2|3
Defined in: graphty-element/src/catalog/types.ts:736
options ​
options: readonly
OptionDescriptor[]
Defined in: graphty-element/src/catalog/types.ts:739
plainName ​
plainName:
string
Defined in: graphty-element/src/catalog/types.ts:731
scoped ​
scoped:
boolean
Defined in: graphty-element/src/catalog/types.ts:759
Whether the default engine accepts a scope: setLayout(type, opts, { scope }) moves only the scope's nodes and holds every other node still.
A picker reads it to know where a "Lay out this set" control does something. Of the element's own engines, the five live simulations answer true; a one-shot arrangement refuses a scope with E_UNSUPPORTED.
sizeRating ​
sizeRating:
"any"|10000|2000|500
Defined in: graphty-element/src/catalog/types.ts:737
structuralInputs ​
structuralInputs: readonly (
"node"|"partition"|"ordering")[]
Defined in: graphty-element/src/catalog/types.ts:738
technicalName ​
technicalName:
string
Defined in: graphty-element/src/catalog/types.ts:732