Interfaces U–U
Import these from @grafloria/engine.
Interfaces
UnifiedLayoutResult
Also has every member of LayoutResult, listed on its own entry.
How a layout engine reports back.
tsinterface UnifiedLayoutResult extends LayoutResult
Properties
| Name | Type | Default | Description |
|---|---|---|---|
algorithm | string | The algorithm that actually ran. | |
seed | number | The seed used — so a pleasing random layout can be reproduced on demand. | |
selection? | LayoutSelectionReport | . Present when the AUTO layout ran: which algorithm it chose, why, and what every other candidate scored. An auto-selector that cannot show its working is a support ticket. | |
partial | boolean | True when the run was cut short (cancelled, or out of time budget) and this is the BEST-SO-FAR answer rather than a finished one. | |
reason? | LayoutStopReason | Why it stopped early, when it did. | |
iteration | number | Iterations actually completed. | |
totalIterations | number | Iterations the algorithm would have run, left alone. |
Was this page helpful?