g3-toolkit API Reference
    Preparing search index...

    Interface MinimapProps

    interface MinimapProps {
        ariaLabel?: string;
        className?: string;
        core?: Core | null;
        cy?: Core | null;
        height?: number;
        nodeFilter?: (node: NodeSingular) => boolean;
        nodeRadius?: number;
        padding?: number;
        style?: CSSProperties;
        width?: number;
    }
    Index

    Properties

    ariaLabel? className? core? cy? height? nodeFilter? nodeRadius? padding? style? width?

    Properties

    ariaLabel?: string

    Accessible label for the minimap region.

    className?: string
    core?: Core | null

    The Cytoscape instance from the canvas onReady callback. While null (or omitted) the minimap renders a disabled placeholder. The same prop name every handle-taking component uses (issue #18).

    cy?: Core | null

    Use core. Accepted as an alias for one major and removed in the next major; when both are supplied core wins and this prop is ignored. Warns once per component in development when it is the only handle given.

    height?: number

    Minimap height in CSS px. Default 140.

    nodeFilter?: (node: NodeSingular) => boolean

    Optional predicate selecting which TOP-LEVEL nodes are drawn. Use it to hide rendering-only nodes (for example structural ports). It composes with the built-in visibility check: nodes that are not visible() are already skipped, so the predicate only narrows further and need not restate visibility. Edges touching a skipped node are skipped too. Children of a compound parent are never drawn individually regardless; the parent is collapsed to a single rectangle.

    nodeRadius?: number

    Drawn node dot radius in px. Default 2.

    padding?: number

    Inner padding around the scaled graph in px. Default 10.

    style?: CSSProperties
    width?: number

    Minimap width in CSS px. Default 200.

    Settings

    Member Visibility

    On This Page

    Properties