pivotick - v3.0.0
    Preparing search index...

    Interface GraphUI

    interface GraphUI {
        asyncContent?: AsyncContentOptions;
        busyIndicator?: boolean | BusyIndicatorOptions;
        contextMenu: ContextMenu;
        dock?: DockOptions;
        editors: Editors;
        emptyState?: boolean | EmptyStateOptions;
        extraPanels: ExtraPanel[];
        filter?: FilterOptions;
        history?: FeatureToggle;
        inspector?: FeatureToggle;
        keybindings?: Keybinding[];
        legend?: boolean | LegendOptions | LegendGroupOptions;
        mainHeader: MainHeader;
        minimap?: boolean | MinimapOptions;
        mode: GraphUIMode;
        navigation: Navigation;
        neighborsPanel: NeighborsPanel;
        notes?: FeatureToggle;
        notifications?: FeatureToggle;
        physicsFlyout?: FeatureToggle;
        pivotMode?: boolean | "auto";
        propertiesPanel: PropertiesPanel;
        search?: FeatureToggle;
        sidebar: SidebarOptions;
        simplify?: SimplifyOptions;
        table?: boolean | TableOptions;
        theme?: string;
        tooltip: Tooltip;
        topBar?: TopBar;
        viewFlyout?: FeatureToggle;
    }
    Index

    Properties

    asyncContent?: AsyncContentOptions

    /**

    • What to show while a content hook's promise is in flight, and if it
    • rejects. Only async hooks ever reach it — see AsyncContentOptions.
    busyIndicator?: boolean | BusyIndicatorOptions

    What the canvas shows while it waits on one of your async hooks (onBeforeEdgeCreate, onBeforeDelete, onBeforeNodeCreate, the edit-commit hooks, onBeforeIngest): a progress cursor and a small spinner, never while a prompt the hook opened through its context is on screen. false shows nothing, for a consumer that draws its own. See BusyIndicatorOptions.

    true
    
    contextMenu: ContextMenu

    The bottom dock itself — the region the table and any registered DockTab share, rather than what is in it.

    UI.table carries the same three settings; those are honoured, and anything set here wins. Declare them here when the table is switched off, since that is the only way to reach the dock a plugin's tab brings with it.

    editors: Editors
    emptyState?: boolean | EmptyStateOptions

    What the canvas says while the graph holds no node and no note: a card centred in the canvas, shown and hidden as data comes and goes, so an ingest takes it away and undoing that ingest brings it back.

    Left out, or true, it reads "Nothing on the canvas yet". false shows nothing. Declare render to say something of your own. See EmptyStateOptions.

    true
    
    extraPanels: ExtraPanel[]
    filter?: FilterOptions

    The filter panel's facets. Omit to derive them by scanning node data (the zero-config default); declare facets to generate the form from your own declaration instead. See FilterOptions.

    history?: FeatureToggle

    The undo / redo split buttons, their history dropdown and Mod+Z / Mod+Shift+Z.

    Only the controls: graph.history goes on recording either way, so a consumer driving undo from its own chrome switches this off and keeps the engine.

    { enabled: true }
    
    inspector?: FeatureToggle

    The inspect-properties modal — the node menu's Inspect Properties entry and the I shortcut.

    { enabled: true }
    
    keybindings?: Keybinding[]
    legend?: boolean | LegendOptions | LegendGroupOptions

    The canvas legend: a key for the graph's colours that doubles as a filter.

    Left out, a legend appears by itself when the graph's colours are explained by a declared render.nodeTypeAccessor — see LegendOptions. false suppresses it, true asks for it without the check, and an object configures it. A graph that encodes several things at once passes LegendGroupOptions instead: one docked card, one section per encoding.

    mainHeader: MainHeader
    minimap?: boolean | MinimapOptions

    The canvas minimap: an overview of the whole graph with a rectangle showing what is on screen. Click it to recentre the view, drag it to pan.

    full mode mounts one for you, opening in collapsed: 'auto' so it folds itself away on a canvas with no corner to spare. false suppresses it; true or an object asks for it in any mode — see MinimapOptions. Passing your own minimap() plugin in plugins also wins over this.

    navigation: Navigation
    neighborsPanel: NeighborsPanel

    Free-floating notes on the canvas: the strip's Notes button and its panel, the Create ▸ Add note tool, the canvas menu's Add Note, and the N / Shift+N shortcuts.

    enabled: false takes every one of them away and closes the door behind them: graph.noteManager.addNote refuses, so nothing — not a plugin, not the initial data — puts a note on a canvas that offers no way to read or remove one.

    { enabled: true }
    
    notifications?: FeatureToggle

    Toast notifications. enabled: false silences the corner: every graph.notifier.* call becomes a no-op returning undefined, which is already what a mode with no notification slot returns.

    { enabled: true }
    
    physicsFlyout?: FeatureToggle

    The Physics rail mode — the flyout holding the simulation sliders and presets. enabled: false takes its rail button and its panel away; whether the simulation runs at all is simulation.enabled's business.

    { enabled: true }
    
    pivotMode?: boolean | "auto"

    The Pivot rail mode — where an analyst picks an origin, reads what each registered pivot advertises, narrows it and runs it.

    'auto' (the default) ties the rail button to the registry: it appears when the first pivot registers and goes when the last one leaves, so a consumer with no pivots sees no trace of the feature. true keeps it there regardless, for pivots that arrive asynchronously; false never shows it. Never mounted in viewer or static mode.

    'auto'
    
    propertiesPanel: PropertiesPanel
    search?: FeatureToggle

    Node search: the header's Search button, its picker modal and Shift+J. graph.selectElement and the pickers other features open are untouched.

    { enabled: true }
    
    simplify?: SimplifyOptions

    Fold nodes that play the same role into one group node, and the Simplify rail mode that switches the rules. Left out, full mode offers the neighbour rule switched off; the other modes show and run nothing unless rules are declared. enabled: false removes the feature.

    table?: boolean | TableOptions

    The data dock: the graph's nodes and edges as a sortable, selectable grid split off the bottom of the canvas.

    full mode offers one by default; false suppresses it entirely, an object configures it. Other modes never mount it. See TableOptions.

    theme?: string

    The classname of the theme to force the UI to ignore user's prefered color scheme. Available by default: light and dark. Keep it undefined to use user's prefered color scheme.

    undefined
    
    tooltip: Tooltip
    topBar?: TopBar

    The strip along the top of the canvas: the Search / Filter / Notes pills, the host's own TopBar.actions and the undo-redo group. enabled: false removes the strip, the 48px it reserved and the shortcuts its controls own.

    Not to be confused with GraphUI.mainHeader, which is how elements are named wherever they are shown. Each pill also has its own switch (GraphUI.search, UI.filter.enabled, GraphUI.notes, GraphUI.history) for taking one away rather than all of them.

    { enabled: true }
    
    viewFlyout?: FeatureToggle

    The View rail mode — the flyout holding the layout, grid and visibility switches. enabled: false takes its rail button and its panel away.

    { enabled: true }