pivotick - v3.0.0
    Preparing search index...

    Interface Tooltip

    interface Tooltip {
        allowPinning?: boolean;
        edgeHeaderMap: Partial<HeaderMapEntry<Edge>>;
        edgePropertiesMap: (
            edge: Edge,
            ctx: RenderContext,
        ) => PropertyEntry[] | Promise<PropertyEntry[]>;
        enabled?:
            | boolean
            | TooltipKinds
            | ((element: Node | Edge, kind: TooltipKind) => boolean);
        nodeHeaderMap: Partial<HeaderMapEntry<Node>>;
        nodePropertiesMap: (
            node: Node,
            ctx: RenderContext,
        ) => PropertyEntry[] | Promise<PropertyEntry[]>;
        render?:
            | string
            | HTMLElement
            | ((element: Node | Edge, ctx: RenderContext) => RenderResult);
        renderEdgeExtra?: (edge: Edge, ctx: RenderContext) => RenderResult;
        renderGroupExtra?: (group: GroupInfo, ctx: RenderContext) => RenderResult;
        renderNodeExtra?: (node: Node, ctx: RenderContext) => RenderResult;
        setPosition?: (
            tooltip: HTMLElement,
            hoveredBCR: DOMRect,
            canvasBbox: DOMRect,
        ) => void;
    }
    Index

    Properties

    allowPinning?: boolean
    edgeHeaderMap: Partial<HeaderMapEntry<Edge>>
    edgePropertiesMap: (
        edge: Edge,
        ctx: RenderContext,
    ) => PropertyEntry[] | Promise<PropertyEntry[]>

    May be async — the property list shows a placeholder until it resolves.

    enabled?:
        | boolean
        | TooltipKinds
        | ((element: Node | Edge, kind: TooltipKind) => boolean)

    Which hovers show a tooltip.

    • true / false: all or none.
    • { nodes, edges, groups }: per kind. A missing key is true, so { edges: false } means everything but edges.
    • (element, kind) => boolean: asked on every hover. One that throws counts as false.
    true
    
    nodeHeaderMap: Partial<HeaderMapEntry<Node>>
    nodePropertiesMap: (
        node: Node,
        ctx: RenderContext,
    ) => PropertyEntry[] | Promise<PropertyEntry[]>

    May be async — the property list shows a placeholder until it resolves.

    render?:
        | string
        | HTMLElement
        | ((element: Node | Edge, ctx: RenderContext) => RenderResult)

    Custom renderer for the tooltip. This content will override the default tooltip

    undefined
    
    (element) => `element id: ${element.id}`
    

    A returned string renders as plain text; return an HTMLElement to render HTML. May be async, on the same terms as Tooltip.renderNodeExtra.

    renderEdgeExtra?: (edge: Edge, ctx: RenderContext) => RenderResult

    Custom renderer for edge tooltips. This content is added after the default tooltip.

    May be async, on the same terms as Tooltip.renderNodeExtra.

    undefined
    
    renderGroupExtra?: (group: GroupInfo, ctx: RenderContext) => RenderResult

    Custom renderer for a group's tooltip, made by UI.simplify. Added after its members and the nodes it links to. A group skips render and renderNodeExtra, which are about one node's data.

    May be async, on the same terms as Tooltip.renderNodeExtra.

    undefined
    
    renderNodeExtra?: (node: Node, ctx: RenderContext) => RenderResult

    Custom renderer for node tooltips. This content is added after the default tooltip.

    May be async — the tooltip shows a placeholder, then swaps in the content and repositions itself. Hovering another node first drops the stale result and aborts ctx.signal.

    undefined
    
    setPosition?: (
        tooltip: HTMLElement,
        hoveredBCR: DOMRect,
        canvasBbox: DOMRect,
    ) => void