Skip to content

@graphty/graphty-element / catalog / MetricAvailability

Interface: MetricAvailability ​

Defined in: graphty-element/src/catalog/types.ts:955

Whether a metric can be computed on this graph, what it would cost, and whether it has already been run. Metrics that have never been run are listed too, which is what makes the catalogue self-describing: a stranger can see everything the element could compute, with a cost and an availability reason beside each entry, before computing anything.

Properties ​

available ​

available: boolean

Defined in: graphty-element/src/catalog/types.ts:959


costClass ​

costClass: "instant" | "iterative" | "heavy" | "cubic" | "unbounded"

Defined in: graphty-element/src/catalog/types.ts:962


estimateSeconds ​

estimateSeconds: number

Defined in: graphty-element/src/catalog/types.ts:963


hasRun ​

hasRun: boolean

Defined in: graphty-element/src/catalog/types.ts:964


key ​

key: AlgorithmKey

Defined in: graphty-element/src/catalog/types.ts:956


plainName ​

plainName: string

Defined in: graphty-element/src/catalog/types.ts:957


reason? ​

optional reason?: string

Defined in: graphty-element/src/catalog/types.ts:961

Why it is unavailable on this graph. Present only when available is false.


runIds ​

runIds: readonly string[]

Defined in: graphty-element/src/catalog/types.ts:965


technicalName ​

technicalName: string

Defined in: graphty-element/src/catalog/types.ts:958