@graphty/graphty-element / extend / metricFieldSpecs

Function: metricFieldSpecs()

metricFieldSpecs(kind, valueType?): readonly ResultFieldSpec[]

Defined in: graphty-element/src/algorithms/results/fields.ts:20

The fields a metric result publishes: the value the algorithm measured, and the ranking and range the element derives from that column.

Parameters

kind

"node" | "edge"

Whether the metric is measured per node or per edge.

valueType?

"number" | "integer"

What the measured value is: a real number, or a whole one such as a count or a position.

Returns

readonly ResultFieldSpec[]

The field list.