Skip to content
D
Documentation

Layout — interfaces u–u

reference
1 min readUpdated

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.

ts
interface UnifiedLayoutResult extends LayoutResult

Properties

NameTypeDefaultDescription
algorithmstringThe algorithm that actually ran.
seednumberThe 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.
partialbooleanTrue 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?LayoutStopReasonWhy it stopped early, when it did.
iterationnumberIterations actually completed.
totalIterationsnumberIterations the algorithm would have run, left alone.

Was this page helpful?

Layout — interfaces u–u — Grafloria