Skip to content

@graphty/graphty-element / index / RunAlgorithmOptions

Interface: RunAlgorithmOptions ​

Defined in: graphty-element/src/utils/queue-migration.ts:59

Extends ​

Properties ​

algorithmOptions? ​

optional algorithmOptions?: AlgorithmSpecificOptions

Defined in: graphty-element/src/utils/queue-migration.ts:69

Algorithm-specific options (source, target, etc.) These are passed to the algorithm's configure method.


applySuggestedStyles? ​

optional applySuggestedStyles?: boolean

Defined in: graphty-element/src/utils/queue-migration.ts:63

Automatically apply suggested styles after running the algorithm


description? ​

optional description?: string

Defined in: graphty-element/src/utils/queue-migration.ts:17

Custom description for the operation (for debugging/logging)

Inherited from ​

QueueableOptions.description


obsoletes? ​

optional obsoletes?: OperationCategory[]

Defined in: graphty-element/src/utils/queue-migration.ts:22

Categories that this operation should obsolete

Inherited from ​

QueueableOptions.obsoletes


respectProgress? ​

optional respectProgress?: 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


skipQueue? ​

optional skipQueue?: 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.

Inherited from ​

QueueableOptions.skipQueue