Skip to content

pivotick v3.0.0


pivotick / MinimapOptions

Interface: MinimapOptions ​

Defined in: plugins/minimap/options.ts:8

minimap(options) — how the minimap is placed and sized. Everything else about it (level of detail, when it redraws) adapts to the graph and needs no configuration.

Properties ​

collapsed? ​

optional collapsed: boolean | "auto"

Defined in: plugins/minimap/options.ts:31

Which state the minimap opens in. The toggle is always there — this only decides where it starts.

'auto' keeps it open unless the canvas is too small to give a 200px overlay away, and follows the canvas from then on: collapsing when the room goes (the sidebar opening, the window shrinking) and coming back when it returns. The first manual toggle — or any setCollapsed call — ends that and the choice sticks.

Default ​

false — but 'auto' for the minimap full mode mounts for you


height? ​

optional height: number

Defined in: plugins/minimap/options.ts:37

Height in CSS pixels. Left out, it follows the canvas's aspect ratio (clamped to 70–400px) so the viewport rectangle keeps the shape of the real viewport.

Default ​

ts
derived from the canvas

position? ​

optional position: MinimapPosition

Defined in: plugins/minimap/options.ts:14

The corner it docks in. 'bottom-right' is the only corner the built-in chrome leaves free in full mode.

Default ​

ts
'bottom-right'

width? ​

optional width: number

Defined in: plugins/minimap/options.ts:19

Width in CSS pixels.

Default ​

ts
200