Skip to content

@graphty/graphty-element / session / ResultColumnDescriptor

Interface: ResultColumnDescriptor ​

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

A run whose result a page of one kind can show as a column: what SessionDataApi.resultColumns lists.

Properties ​

field ​

readonly field: string

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

The run's primary field, which a column naming only the run reads.


grouping ​

readonly grouping: boolean

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

The field names groups (a community's group, a hierarchy's level), so a sort by it orders records by group size, largest group first when descending, rather than by the group's id.


path ​

readonly path: string

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

The published path of the field, as a style selector or a filter reads it.


run ​

readonly run: string

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

The run's id; pass it, or the run, in columns or sort.


type ​

readonly type: "string" | "number" | "boolean" | "integer"

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

The field's declared type.