pivotick - v1.5.0
    Preparing search index...

    Interface GraphOptions

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

    interface GraphOptions {
        callbacks?: InterractionCallbacks.InterractionCallbacks<unknown>;
        isDirected?: boolean;
        layout?: DeepPartial<LayoutOptions.LayoutOptions>;
        plugins?: PivotickPlugin[];
        render?: DeepPartial<GraphRendererOptions>;
        simulation?: DeepPartial<SimulationOptions.SimulationOptions>;
        UI?: DeepPartial<GraphUI.GraphUI>;
    }
    Index

    Properties

    callbacks? isDirected? layout? plugins? render? simulation? UI?

    Properties

    callbacks?: InterractionCallbacks.InterractionCallbacks<unknown>

    Callbacks to handle various graph events and render hooks.

    isDirected?: boolean

    Enable whether the graph is directed or not

    true
    layout?: DeepPartial<LayoutOptions.LayoutOptions>

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

    plugins?: PivotickPlugin[]

    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?: DeepPartial<GraphRendererOptions>

    Options for the rendering engine

    simulation?: DeepPartial<SimulationOptions.SimulationOptions>

    Options for the simultion engine

    UI?: DeepPartial<GraphUI.GraphUI>

    Options for the UI

    Settings

    Member Visibility

    On This Page

    Properties