# diagram-maker-plugin-minimap

**Repository Path**: bluestone029/diagram-maker-plugin-minimap

## Basic Information

- **Project Name**: diagram-maker-plugin-minimap
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-05-21
- **Last Updated**: 2022-05-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Diagram Maker Minimap Plugin
[![Build Status](https://travis-ci.com/awslabs/diagram-maker-plugin-minimap.svg?branch=master)](https://travis-ci.com/awslabs/diagram-maker-plugin-minimap)

[Diagram Maker Minimap Plugin](https://awslabs.github.io/diagram-maker-plugin-minimap) is a plugin to display a minimap for [Diagram Maker](https://github.com/awslabs/diagram-maker) to help in navigating large workspaces with lots of nodes & edges. Minimap is a smaller scale rendering of your entire canvas. This is most useful when the canvas is much larger than the container or the screeen that Diagram maker is rendering in and traversing the full canvas requires scrolling it several times. In such a case, minimap provides an overview of the full canvas along with all the nodes present in it. Furthermore, users can jump to parts of the canvas they're interested in by clicking on that area in the minimap in a single click rather than by scrolling several times.

A mockup of how a panel might be rendered using the minimap plugin within the Diagram Maker editor.
![Minimap Mockup](docs/assets/MinimapMockup.png)

## Explore

### Interactive Demo
Check out one of our interactive demos [here](https://awslabs.github.io/diagram-maker-plugin-minimap/examples/WideMinimap.html) or see the full list of interactive demos [here](https://awslabs.github.io/diagram-maker-plugin-minimap/explore/demos.html). The code for these demos can be found [here](https://github.com/awslabs/diagram-maker-plugin-minimap/tree/master/integ).

## How do I use it?

### Installation
Check out our installation guide [here](https://awslabs.github.io/diagram-maker-plugin-minimap/getting-started/install.html).

### Usage
Check out our usage guide [here](https://awslabs.github.io/diagram-maker-plugin-minimap/usage/integration.html).

## Docs
Check out our full documentation [here](https://awslabs.github.io/diagram-maker-plugin-minimap).

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## License

This project is licensed under the Apache-2.0 License.