Skip to content

@graphty/graphty-element / session / TableMappingRead

Interface: TableMappingRead ​

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

One table's roles as the element reads them: rowsAre always set, endpoints always objects.

Extends ​

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.

Inherited from ​

TableMapping.edgeId


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.

Inherited from ​

TableMapping.key


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.

Inherited from ​

TableMapping.label


rowsAre ​

readonly rowsAre: "edges" | "nodes"

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

Whether each row is a node or an edge.

Overrides ​

TableMapping.rowsAre


source? ​

readonly optional source?: Endpoint

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

The column holding the node an edge leaves.

Overrides ​

TableMapping.source


target? ​

readonly optional target?: Endpoint

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

The column holding the node an edge enters.

Overrides ​

TableMapping.target


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.

Inherited from ​

TableMapping.time


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.

Inherited from ​

TableMapping.weight