@graphty/graphty-element / index / SetLayoutOptions
Interface: SetLayoutOptions ​
Defined in: graphty-element/src/utils/queue-migration.ts:33
What setLayout accepts as its third argument: the queue options, and what the layout runs over.
Extends ​
Properties ​
description? ​
optionaldescription?:string
Defined in: graphty-element/src/utils/queue-migration.ts:17
Custom description for the operation (for debugging/logging)
Inherited from ​
obsoletes? ​
optionalobsoletes?:OperationCategory[]
Defined in: graphty-element/src/utils/queue-migration.ts:22
Categories that this operation should obsolete
Inherited from ​
respectProgress? ​
optionalrespectProgress?:boolean
Defined in: graphty-element/src/utils/queue-migration.ts:27
Whether to respect progress when obsoleting (don't cancel >90% complete)
Inherited from ​
QueueableOptions.respectProgress
scope? ​
optionalscope?:ScopeInput
Defined in: graphty-element/src/utils/queue-migration.ts:44
What the layout runs over. The scope's nodes move and every other node is held still; a node added after the layout starts is held too, because the members are the ones the scope had when the layout started.
CARRIED: absent keeps the scope the last layout ran over, so changing one option never un-scopes a layout; "graph" clears it. Only a live simulation accepts one -- a layout whose catalogue entry reads scoped: false refuses it with E_UNSUPPORTED -- and a scope that is malformed or names a removed set is refused with E_BAD_COMMAND.
skipQueue? ​
optionalskipQueue?:boolean
Defined in: graphty-element/src/utils/queue-migration.ts:12
Skip the operation queue and execute immediately (for backwards compatibility).
This also skips what the queue runs after the operation: nodes or edges added this way are not repainted from the style layers and do not start the load-time algorithm list (runAlgorithmsOnLoad). Leave it unset for data pushes.