Skip to content

@graphty/graphty-element / index / ColumnRef

Interface: ColumnRef ​

Defined in: graphty-element/src/session/shared.ts:25

A data column, named literally: whether it is on nodes or on edges, and the key the records carry it under.

The name is the column's own name, exactly as the file spelled it -- shared chapters, a.b and w || x are all ordinary names here -- and never an expression. An AttributeDescriptor from session.data.attributes() has both fields, so it can be passed wherever a ColumnRef is asked for.

ts
const department = session.data.attributes().find((a) => a.kind === "node" && a.name === "department");

Properties ​

kind ​

readonly kind: "node" | "edge"

Defined in: graphty-element/src/session/shared.ts:27

Whether the column is carried by nodes or by edges. A node and an edge column may share a name.


name ​

readonly name: string

Defined in: graphty-element/src/session/shared.ts:29

The column's name, literally.