@graphty/graphty-element / session / TableMapping

Interface: TableMapping

Defined in: graphty-element/src/session/types.ts:1129

The column roles of one table. Every value is a column name exactly as DraftColumn.name spells it, never an expression. Absent means the element's own reading; null means none. A name that is not a column of the table is refused with E_UNKNOWN_ATTRIBUTE.

Extended by

• TableMappingRead

Properties

edgeId?

readonly optional edgeId?: string | null

Defined in: graphty-element/src/session/types.ts:1145

The column holding an edge's own id. Written to data.knownFields.edgeIdPath.

---

key?

readonly optional key?: string | null

Defined in: graphty-element/src/session/types.ts:1133

A node table's id column; null numbers the rows instead.

---

label?

readonly optional label?: string | null

Defined in: graphty-element/src/session/types.ts:1135

The column that names a node. Written to data.knownFields.nodeLabelPath.

---

rowsAre?

readonly optional rowsAre?: "edges" | "nodes"

Defined in: graphty-element/src/session/types.ts:1131

Whether each row is a node or an edge.

---

source?

readonly optional source?: string | Endpoint

Defined in: graphty-element/src/session/types.ts:1137

The column holding the node an edge leaves.

---

target?

readonly optional target?: string | Endpoint

Defined in: graphty-element/src/session/types.ts:1139

The column holding the node an edge enters.

---

time?

readonly optional time?: string | null

Defined in: graphty-element/src/session/types.ts:1143

The column holding a time. Written to data.knownFields.nodeTimePath or edgeTimePath.

---

weight?

readonly optional weight?: string | null

Defined in: graphty-element/src/session/types.ts:1141

The edge weight column; null weighs every edge 1, and the legacy value column is not read.