@hanica-dwa/sijs-block-diagram-manipulator

sijs-block-diagram-manipulator

This module provides an example of how to implement a custom module. In this case the module adds a new diagram type, and 2 new shapes.

Getting started

The most notable file of this module for users is the 'BlockDiagramManipulationAPI.ts' file. This file contains a class called 'BlockDiagramManipulationAPI' which implements the DiagramManipulationAPI interface.

Since this class implements the DiagramManipulationAPI interface all methods provided by this interface are inherited and should be implemented accordingly.

The Block Diagram Manipulation Module is passed to the Block Diagram Render module. By registering the Block Diagram Render Module with the Diagram Renderer (explained in the Diagram renderer README, Block Diagram renderer README), the user is able to create a Block diagram.

There is an extensive tutorial available that explains the most notable features of custom Diagram Manipulation module (meaning it's also applicable on the Block Diagram Module).

Module features

The Block Diagram Manipulation Module provides functionality for creating an extremely simple diagram called the 'Block Diagram'. In this diagram the user can place two different shapes (and the default shapes provided by the Default Diagram Manipulation Module). These shapes are 'Block' and 'BlockWithText'. The Block shape is simply a rectangle. The BlockWithText shape is an example of a bit more complex shape, it is a (as the name suggests..) rectangle with text in it. The user can add text to the shape indefinitely. The module does NOT provide any lines.

Developing

This module depends on the DiagramManipulator module.

1. Install the dependencies.
   npm i
2. Run the tests.
   npm run test
3. Build the module.
   npm run build
4. Publish the module.