@graphty/graphty-element / session / EstimateRefusalCode

Type Alias: EstimateRefusalCode

EstimateRefusalCode = "algorithm.unknown" | "algorithm.needs-directed" | "algorithm.needs-undirected" | "algorithm.needs-weighted" | "algorithm.needs-connected" | "algorithm.needs-accelerator" | "estimate.not-costed" | "estimate.scope-unresolved" | "layout.unknown" | "layout.needs-accelerator" | "layout.not-planar" | "layout.needs-node" | "layout.node-missing" | "layout.needs-grouping" | "layout.grouping-absent" | "layout.needs-two-groups"

Defined in: graphty-element/src/session/cost/estimate.ts:128

Why a command cannot run, as CostEstimate.refusal reports it. Each code's parameters:

• algorithm.unknown -- algorithm: the key no algorithm is registered under.
• algorithm.needs-directed, algorithm.needs-undirected, algorithm.needs-weighted, algorithm.needs-accelerator -- algorithm: the algorithm's key.
• algorithm.needs-connected -- algorithm; pieces: how many connected pieces the graph has.
• estimate.not-costed -- op: the command's op; only an algorithm run and a layout choice are costed.
• estimate.scope-unresolved -- error: the error code resolving the run's scope threw, or null.
• layout.unknown -- layout: the id no layout is registered under.
• layout.needs-accelerator -- layout; engine: the engine that needs one.
• layout.not-planar -- layout: the graph cannot be drawn without crossings.
• layout.needs-node -- layout; option: the option that must name the node to start from.
• layout.node-missing -- layout; option; node: the named node, which the graph lacks.
• layout.needs-grouping -- layout; option: the option that must name a node attribute.
• layout.grouping-absent -- layout; option; attribute: the path no node carries; run: the run whose field the path is, or null for a data attribute.
• layout.needs-two-groups -- layout; option; attribute; run; groups: how many groups the attribute names.

New codes may be added in a minor release: treat an unknown one as "cannot run".

Since

3.17.0