@graphty/graphty-element / session / EncodingRun

Interface: EncodingRun

Defined in: graphty-element/src/session/styles/EncodingSpec.ts:179

What planEncoding needs to know about the run it is binding to.

A Run satisfies this as it stands, which is the point: a session hands one over without building an adapter, and nothing here drags the queue, the abort controllers or the progress machinery in behind a question about a result's fields.

Properties

algorithm

readonly algorithm: AlgorithmKey

Defined in: graphty-element/src/session/styles/EncodingSpec.ts:185

Which algorithm produced it, recorded on the layer so the layer can be re-run.

---

fields

readonly fields: readonly FieldDescriptor[]

Defined in: graphty-element/src/session/styles/EncodingSpec.ts:191

The fields it publishes.

---

id

readonly id: string

Defined in: graphty-element/src/session/styles/EncodingSpec.ts:181

The run id, which is the path segment under results.

---

label

readonly label: string

Defined in: graphty-element/src/session/styles/EncodingSpec.ts:183

What to call the run, which becomes half of the layer's name.

---

params

readonly params: Readonly<Record<string, unknown>>

Defined in: graphty-element/src/session/styles/EncodingSpec.ts:187

The parameters it ran with, recorded for the same reason.

---

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/session/styles/EncodingSpec.ts:189

The shape, which fixes the field names and says what a consumer can draw from them.