Skip to content

pivotick v3.0.0


pivotick / minimap

Function: minimap() ​

minimap(options): PivotickPlugin

Defined in: plugins/minimap/index.ts:28

The minimap plugin: a cached overview of the whole graph docked in a canvas corner, with a rectangle showing what is on screen. Click it to recentre the view; drag it to pan.

Built entirely on public API (renderer.getContentBounds / setViewport / screenToGraphCoordinates), so it is exactly as privileged as a plugin you write yourself — and it is renderer-agnostic.

Parameters ​

options ​

MinimapOptions = {}

Placement and size. See MinimapOptions.

Returns ​

PivotickPlugin

Example ​

js
import { Pivotick, minimap } from 'pivotick'

new Pivotick(container, data, { plugins: [minimap({ width: 220 })] })
// …or at any point later:
graph.use(minimap())