pivotick - v2.0.1
    Preparing search index...

    Interface GraphRendererAbstract

    interface GraphRenderer {
        clearEmphasis(): void;
        clearForecast(): void;
        clearHighlightedElements(): void;
        destroy(): void;
        emphasiseElements(elements: (Node | Edge)[]): void;
        enterNoteEditMode(note: Note): void;
        fitAndCenter(forceScale?: number): void;
        fitAndCenterWhenSettled(forceScale?: number): void;
        focusElement(element: Node | Edge | Note): void;
        getCanvas(): HTMLElement;
        getCanvasSelection(): unknown;
        getClosestElementToCursor(maxDistance?: number): Node | Edge | Note | null;
        getContentBounds(): GraphBounds | null;
        getEdgeStyle(edge: Edge): EdgeStyle;
        getGraphInteraction(): GraphInteractions.GraphInteractions<unknown>;
        getNodeClosestToCursor(maxDistance?: number): Node | null;
        getNodeStyle(node: Node): NodeStyle;
        getOptions(): GraphRendererOptions;
        getRootContainer(): HTMLElement;
        getSelectionBox(): AbstractSelectionBox | null;
        getZoomBehavior(): unknown;
        getZoomGroup(): HTMLElement | SVGElement | null;
        graphToScreenCoordinates(graphX: number, graphY: number): Point;
        hideShadowEdge(): void;
        highlightElement(element: Node | Edge): void;
        init(): void;
        nextTick(): void;
        nextTickFor(nodes: Node[]): void;
        screenToGraphCoordinates(screenX: number, screenY: number): Point;
        setupRendering(): void;
        setViewport(target: ViewportTarget): void;
        showForecast(forecast: GraphForecast): void;
        showShadowEdge(
            params: {
                invalid?: boolean;
                source: Node | Note;
                targetNode?: Node;
                targetPosition?: { x: number; y: number };
            },
        ): void;
        toggleLassoMode(enabled: boolean): void;
        unHighlightElement(element: Node | Edge): void;
        update(dataChanged: boolean): void;
        updateLayoutProgress(
            progress: number,
            elapsedTime: number,
            progressType: ProgressType,
        ): void;
        zoomIn(): void;
        zoomOut(): void;
    }
    Index

    Methods

    clearEmphasis clearForecast clearHighlightedElements destroy emphasiseElements enterNoteEditMode fitAndCenter fitAndCenterWhenSettled focusElement getCanvas getCanvasSelection getClosestElementToCursor getContentBounds getEdgeStyle getGraphInteraction getNodeClosestToCursor getNodeStyle getOptions getRootContainer getSelectionBox getZoomBehavior getZoomGroup graphToScreenCoordinates hideShadowEdge highlightElement init nextTick nextTickFor screenToGraphCoordinates setupRendering setViewport showForecast showShadowEdge toggleLassoMode unHighlightElement update updateLayoutProgress zoomIn zoomOut

    Methods

    • Release renderer-owned resources (observers, listeners) on teardown. No-op by default; renderers that hold such resources override this.

      Returns void

    • Parameters

      • OptionalforceScale: number

      Returns void

    • Fit-and-centre once the content has stopped resizing. Renderers that lay out over several frames after the sim stops (e.g. expanded clusters) override this to wait for a stable bbox; the default fits immediately.

      Parameters

      • OptionalforceScale: number

      Returns void

    • Parameters

      • OptionalmaxDistance: number

      Returns Node | null

    • The graph's root container — everything, chrome included. Deliberately distinct from getCanvas: the canvas shrinks whenever chrome opens (a sidebar, the data dock), the container only changes when the page around it does. Anything that must not react to chrome measures this instead.

      Returns HTMLElement

    • Returns HTMLElement | SVGElement | null

    • Parameters

      • graphX: number
      • graphY: number

      Returns Point

    • Parameters

      • screenX: number
      • screenY: number

      Returns Point

    • Parameters

      • params: {
            invalid?: boolean;
            source: Node | Note;
            targetNode?: Node;
            targetPosition?: { x: number; y: number };
        }

      Returns void

    • Parameters

      • enabled: boolean

      Returns void

    • Parameters

      • dataChanged: boolean

      Returns void

    • Parameters

      • progress: number
      • elapsedTime: number
      • progressType: ProgressType

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods