g3-toolkit API Reference
    Preparing search index...

    Interface NeighborhoodPopoutProps

    interface NeighborhoodPopoutProps {
        camera?: "center" | "fit";
        className?: string;
        corner?: "bottom-left" | "bottom-right";
        defaultHops?: number;
        encodingSpec?: EncodingSpec;
        focusId: string;
        focusLabel?: string;
        maxHops?: number;
        onClose: () => void;
        positioning?: "fixed" | "absolute";
        stylesheet?: CyStylesheet[];
        ugm: UGM;
    }
    Index

    Properties

    camera? className? corner? defaultHops? encodingSpec? focusId focusLabel? maxHops? onClose positioning? stylesheet? ugm

    Properties

    camera?: "center" | "fit"

    Camera behavior: "fit" (default: the whole cut in frame) or "center" (close-up on the focus).

    className?: string
    corner?: "bottom-left" | "bottom-right"

    Corner the popout docks to (default bottom-left).

    defaultHops?: number
    encodingSpec?: EncodingSpec

    Upstream P2 + owner VR-24 (both 2026-07-28, found independently): the preview inherits the PARENT canvas's encoding so shapes/colors match the main graph.

    focusId: string
    focusLabel?: string

    Display label for the focus (defaults to the id).

    maxHops?: number
    onClose: () => void
    positioning?: "fixed" | "absolute"

    9.20: "absolute" anchors the popout inside a positioned ancestor (the graph view), instead of the viewport, so it sits over the canvas corner rather than whatever chrome happens to occupy the viewport corner. Default stays "fixed" for existing consumers.

    stylesheet?: CyStylesheet[]

    Extra stylesheet rules, same contract as CytoscapeCanvas.

    ugm: UGM

    The full graph the neighborhood is cut from.

    Settings

    Member Visibility

    On This Page

    Properties