Skip to content

@graphty/graphty-element / extend / ResultFieldSpec

Interface: ResultFieldSpec ​

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

One field a run actually published.

This is deliberately NOT a FieldDescriptor: the plain and technical names a reader sees belong to the catalogue, which states them once for every algorithm. A run knows which of them it filled, in which half of the result and carrying what type -- and nothing more.

Properties ​

kind ​

readonly kind: "node" | "edge" | "graph"

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

Which half of the result the field belongs to.


name ​

readonly name: string

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

The field name, as the result's shape fixes it.


normalization? ​

readonly optional normalization?: string

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

How the values were scaled before publication, when they were scaled at all.


type ​

readonly type: "string" | "number" | "boolean" | "integer" | "table"

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

The type of the values it carries.