@graphty/graphty-element / extend / AlgorithmOutput

Interface: AlgorithmOutput

Defined in: graphty-element/src/algorithms/results/types.ts:57

Everything one run of an algorithm produced.

Returned rather than written through side effects, so a run is a value: it can be handed to a caller, posted to a worker, checked against the catalogue, or thrown away when the run that produced it was cancelled.

Properties

caveats

readonly caveats: Caveats

Defined in: graphty-element/src/algorithms/results/types.ts:72

What qualifies these numbers, including which method produced them.

---

edges?

readonly optional edges?: readonly ResultElementValues<string>[]

Defined in: graphty-element/src/algorithms/results/types.ts:68

What the run published per edge, keyed by the element-assigned Edge.id.

---

fields

readonly fields: readonly ResultFieldSpec[]

Defined in: graphty-element/src/algorithms/results/types.ts:64

The fields this run filled. Fewer than the catalogue declares whenever a parameter changed what there was to publish.

---

graph?

readonly optional graph?: Readonly<Record<string, unknown>>

Defined in: graphty-element/src/algorithms/results/types.ts:70

What the run published for the graph as a whole.

---

nodes?

readonly optional nodes?: readonly ResultElementValues<NodeId>[]

Defined in: graphty-element/src/algorithms/results/types.ts:66

What the run published per node.

---

shape

readonly shape: "node-metric" | "edge-metric" | "community" | "layered-grouping" | "category-table" | "path" | "node-set" | "edge-set" | "pair-list" | "temporal" | "fact"

Defined in: graphty-element/src/algorithms/results/types.ts:59

The result shape, which fixes the field names below.