pivotick / GraphUI / TableOptions
Interface: TableOptions
Defined in: interfaces/GraphUI.ts:1434
The data dock's configuration. Everything here is read-only behaviour: the table reflects and selects, and never changes the graph. Hiding, pinning and restoring stay with the sidebar's bulk actions and the filter panel.
Example
UI: { mode: 'full', table: { open: true, height: 0.4,
sort: { key: 'degree', direction: 'desc' } } }Properties
collapsed?
optionalcollapsed:boolean|"auto"
Defined in: interfaces/GraphUI.ts:1462
Folded away to just its header bar. 'auto' follows the room available, until the first explicit collapse or expand hands control to the user for good.
Default
'auto'columns?
optionalcolumns:TableColumn<Node>[]
Defined in: interfaces/GraphUI.ts:1443
The node columns. Omit to have them resolved for you: from declared FilterOptions.facets if there are any, otherwise by scanning node data.
edgeColumns?
optionaledgeColumns:TableColumn<Edge>[]
Defined in: interfaces/GraphUI.ts:1445
The edge columns, on the same terms as TableOptions.columns.
enabled?
optionalenabled:boolean
Defined in: interfaces/GraphUI.ts:1436
Default
true whenever UI.table isn't false
export?
optionalexport:false|TableExportFormat[]
Defined in: interfaces/GraphUI.ts:1485
Export buttons offered in the dock header. false hides them.
Default
['csv', 'json']filterGraph?
optionalfilterGraph:boolean
Defined in: interfaces/GraphUI.ts:1483
Offer the Apply to graph button, which hides the elements the column filters leave out — the one thing in the dock that changes what the canvas shows.
Nothing happens until it is pressed: narrowing a column is still reading, and the Visibility column goes on reporting the truth beside it. Pass false for a dock that can never touch the canvas at all.
Default
trueheight?
optionalheight:number
Defined in: interfaces/GraphUI.ts:1468
The dock's height: a pixel count, or a fraction of the canvas between 0 and 1. Clamped so the canvas keeps a usable minimum whatever you ask for.
Default
0.35nested?
optionalnested:boolean
Defined in: interfaces/GraphUI.ts:1504
Whether a cluster's nested nodes get rows of their own, as peers of the graph's own nodes, with a Cluster column carrying the path they came from. A Nested nodes switch in the header takes them back out for a reader who only wants the top level.
They are listed flat rather than as a tree on purpose: the dock exists to answer questions the canvas cannot — which are the hubs, which are over a threshold — and that only keeps working if a sort or a filter reaches every row equally.
A nested node is not a node of this graph: the canvas draws it from a separate subgraph, so it has no dot of its own here and its Visibility reads nested while any cluster above it is shut. Pass false for a dock that never lists them, where Children is all a cluster's row says about its contents.
Default
true (the Cluster column appears only on a graph that has clusters)
open?
optionalopen:boolean
Defined in: interfaces/GraphUI.ts:1456
Whether the dock starts expanded. Three states, because the collapsed bar is the control that opens it:
true— present and expanded, showing the grid.false— not present at all, for a canvas with no dock.Shift+Tstill brings it in.- unset (default) — present, folded to its header bar. The bar is the affordance, which is why there is no toolbar button for the dock.
rowActivate?
optionalrowActivate:"select"|"none"|"selectAndCenter"
Defined in: interfaces/GraphUI.ts:1472
What clicking a row does.
Default
'select'sort?
optionalsort:object
Defined in: interfaces/GraphUI.ts:1470
Initial sort.
direction
direction:
TableSortDirection
key
key:
string
Default
the first sortable column, ascendingtabs?
optionaltabs:TableTab[]
Defined in: interfaces/GraphUI.ts:1438
Which tabs to offer, in order.
Default
['nodes', 'edges']virtualizeAbove?
optionalvirtualizeAbove:number
Defined in: interfaces/GraphUI.ts:1487
Row count above which rows are windowed rather than all rendered.
Default
200