Pivotick

English

简体中文
Français
Deutsch
Português

English

简体中文
Français
Deutsch
Português

Appearance

pivotick v3.0.0

pivotick / GraphOptions / GraphOptions

Interface: GraphOptions ​

Defined in: interfaces/GraphOptions.ts:21

Remarks ​

This interface should be used as the entry point when configuring the graph.

Properties ​

callbacks? ​

optional callbacks: InterractionCallbacks<unknown>

Defined in: interfaces/GraphOptions.ts:39

Callbacks to handle various graph events and render hooks.

i18n? ​

optional i18n: I18nOptions

Defined in: interfaces/GraphOptions.ts:56

The language of the text the library writes itself: menus, panels, toasts, tooltips. See I18nOptions.

isDirected? ​

optional isDirected: boolean

Defined in: interfaces/GraphOptions.ts:45

Enable whether the graph is directed or not

Default ​

ts
true

layout? ​

optional layout: DeepPartial<LayoutOptions>

Defined in: interfaces/GraphOptions.ts:34

Layout-specific configuration (e.g. tree, radial, etc.)

pivotCandidateCeiling? ​

optional pivotCandidateCeiling: number

Defined in: interfaces/GraphOptions.ts:77

Absolute ceiling on how many candidates one pivot fetch may stage. A provider that returns more is refused, not truncated.

Default ​

ts
10000

pivotIngestGrouped? ​

optional pivotIngestGrouped: boolean

Defined in: interfaces/GraphOptions.ts:101

Every pivot landing arrives folded into landing groups, one per type (graph.simplify.groupLanding): a one-click run, an autoIngest pivot, and Review's main buttons. Review then offers Ingest loose for a landing drawn as separate nodes. Ignored while UI.simplify is off.

Default ​

ts
false

pivotMarkUnsaved? ​

optional pivotMarkUnsaved: boolean

Defined in: interfaces/GraphOptions.ts:145

Put a pvt-node-unsaved class on every node a pivot run created and has not written back yet, so a stylesheet can mark them.

A class rather than a badge: the rim rations four corners and only two on the container nodes an enrichment produces, and a marker that pushes a declared potential off the rim costs more than it says. Off by default — the count in the Pivot panel is the surface that always tells the truth about this.

Default ​

ts
false

pivotQuickIngestLimit? ​

optional pivotQuickIngestLimit: number

Defined in: interfaces/GraphOptions.ts:92

How many candidates a one-click pivot may land on the canvas without offering triage first — a context-menu pivot row, or a rim badge with a single pivot to offer. Only candidates that are new count: what dedup will skip does not, and an edge between two nodes already on screen does.

It decides nothing for a pivot that declared PivotDefinition.autoIngest either way, and nothing at all for a run started from the Pivot panel — going there to read the counts is never answered by having the results land instead.

0 sends every one-click run with something new in it to triage.

Default ​

ts
50

pivotRimBadge? ​

optional pivotRimBadge: PivotRimBadge

Defined in: interfaces/GraphOptions.ts:120

What the library puts on a node's rim for its pivots.

  • 'per-pivot' — one badge per pivot that declared a potential for this node, each opening that pivot. What a handful of providers wants.
  • 'summary' — one badge for all of them, whatever the provider count. It shows the total declared through Node.setPotential with no pivot id, or, failing that, how many pivots apply to the node. Clicking it opens the Pivot panel on that node — unless exactly one pivot applies and it has nothing to narrow, which runs straight away.
  • 'off' — nothing. NodeStyle.badges still draws.

A node has four rim corners and only two once it has children, so 'per-pivot' stops being readable somewhere around a dozen providers. 'summary' is the answer at a hundred.

Default ​

ts
'per-pivot'

pivotRimBadgeVisible? ​

optional pivotRimBadgeVisible: PivotRimBadgeVisibility

Defined in: interfaces/GraphOptions.ts:133

When the pivotRimBadge badges are drawn.

  • 'pivot-mode' — only while the Pivot rail mode is open, where they help pick an origin. Clicking one there scopes the panel to that node and pivot.
  • 'always' — whatever the mode, so a badge is also a way into Pivot mode.
  • 'never' — not at all. The same as pivotRimBadge: 'off'.

graph.pivots.rimBadgeVisible changes it later.

Default ​

ts
'pivot-mode'

pivots? ​

optional pivots: PivotDefinition[]

Defined in: interfaces/GraphOptions.ts:70

Pivots to register before anything is built, so the UI's first paint already knows whether there are any. See Graph.pivots for the imperative door and PluginContext.addPivot for the plugin one.

pivotSaveControls? ​

optional pivotSaveControls: boolean

Defined in: interfaces/GraphOptions.ts:155

Whether the Pivot panel and the triage pane show what is unsaved with a Save that writes all of it. Off, the consumer offers saving where it wants, through graph.pivots.save(...); the ledger and the save itself are unchanged.

graph.pivots.saveControls changes it later.

Default ​

ts
true

plugins? ​

optional plugins: PivotickPlugin[]

Defined in: interfaces/GraphOptions.ts:63

Plugins to install after the UI is built. Each is handed a PluginContext and can add UI elements, keybindings and lifecycle hooks. See Graph.use for imperative registration.

render? ​

optional render: DeepPartial<GraphRendererOptions>

Defined in: interfaces/GraphOptions.ts:25

Options for the rendering engine

simulation? ​

optional simulation: DeepPartial<SimulationOptions>

Defined in: interfaces/GraphOptions.ts:29

Options for the simultion engine

UI? ​

optional UI: DeepPartial<GraphUI>

Defined in: interfaces/GraphOptions.ts:50

Options for the UI