WeaveStageMinimapPlugin

Overview

The WeaveStageMinimapPlugin class represents a plugin that renders a scaled-down preview of the stage content on a specified DOM node, useful for quick navigation and orientation. It renders the entire stage (including padding) into a miniature view and overlays a viewport rectangle that indicates the currently visible region.

The class extends the WeavePlugin class

Name

This plugin name property value is stageMinimap.

Import

import { WeaveStageMinimapPlugin } from "@inditextech/weave-sdk";

Instantiation

new WeaveStageMinimapPlugin(params: WeaveStageMinimapPluginParams);

TypeScript types

type WeaveStageMinimapPluginStyle = {
  viewportReference: Konva.RectConfig;
};

type WeaveStageMinimapPluginConfig = {
  getContainer: () => HTMLElement;
  id: string;
  width: number;
  fitToContentPadding: number;
  style: WeaveStageMinimapPluginStyle;
};

type WeaveStageMinimapPluginParams = {
  config: Pick<
    WeaveStageMinimapPluginConfig,
    "getContainer" | "id" | "width" | "fitToContentPadding"
  > &
    DeepPartial<Pick<WeaveStageMinimapPluginConfig, "style">>;
};

Parameters

For WeaveStageMinimapPluginParams:

Prop	Type	Default
`config`	`WeaveStageMinimapPluginConfig`	-

For WeaveStageMinimapPluginConfig:

Prop	Type	Default
`style?`	`WeaveStageMinimapPluginStyle`	-
`fitToContentPadding`	`number`	-
`width`	`number`	-
`id`	`string`	-
`getContainer`	`() => HTMLElement`	-