Options

Required type

string

Plugin type

className

string

The class name of the minimap canvas, which does not take effect when an external container is passed in

container

HTMLElement | string

The container where the minimap is mounted, if not, it will be mounted to the container where the Graph is located

containerStyle

Partial**<**CSSStyleDeclaration__>

The style of the minimap container, which does not take effect when an external container is passed in

delay

number Default: 128

Delay update time(ms), used for performance optimization

filter

(id: string, elementType: 'node' | 'edge' | 'combo'__) => boolean

Filter, used to filter elements that do not need to be displayed

maskStyle

Partial**<**CSSStyleDeclaration__>

The style of the mask

padding

number | number[] Default: 10

Padding

position

[number, number] | 'left' | 'right' | 'top' | 'bottom' | 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center' Default: 'right-bottom'

The position of the minimap relative to the canvas

renderer

IRenderer

Renderer, default to use Canvas renderer

shape

'key' | ((id: string, elementType: 'node' | 'edge' | 'combo'__) => DisplayObject__) Default: 'key'

The method of generating the thumbnail of the element

• 'key' uses the key shape of the element as the thumbnail shape - You can also pass in a function that receives the id and type of the element and returns a shape

size

[number, number] Default: [240, 160]

Width and height

API

Minimap.destroy()

destroy(): void;

Minimap.update(options)

update(options: Partial<MinimapOptions>): void;