@gip-recia/wisemapping-mindplot

6.0.0-recia-1.0.2405231 • Public • Published

WiseMapping Mindplot

WiseMapping Mindplot module is the core mind map rerendering of WiseMapping. This lighway library allows eithe edition and visualization of saved mindmaps.

Usage

A WebComponent implementation for mindplot designer is available. This component is registered as mindplot-component in customElements API. (see https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry/define) For use it you need to import minplot.js and put in your DOM a tag. In order to create a Designer on it you need to call its buildDesigner method. Maps can be loaded through loadMap method.

Code example

<!doctype html>
<html>
  <head>
    <script src="mindplot.js"></script>
  </head>
  <body>
    <mindmap-comp id="mindmap-comp" mode="viewonly"></mindmap-comp>
    <script>
      var webComponent = document.getElementById('mindmap-comp');
      webComponent.buildDesigner(persistence, widget);
      webComponent.loadMap('1');
    </script>
  </body>
</html>

Optionaly you can use your own presistence manager and widget manager. If you don't have special requirements you can use the defaults.

var persistence = new LocalStorageManager('map.xml', false, false);
var widget = new MyAwesomeWidgetManager();
// then build the designer with these params
webComponent.buildDesigner(persistence, widget);

Usage with React framework

To use the web component in your JSX code, first you need to register it in the IntrinsicElements interface using provided MindplotWebComponentInterface

TypeScript example

import { MindplotWebComponentInterface } from '@gip-recia/wisemapping-mindplot';

declare global {
  namespace JSX {
    interface IntrinsicElements {
      ['mindplot-component']: MindplotWebComponentInterface;
    }
  }
}

const App = ()=>{
  const mindplotComponent: any = useRef();

  useEffect(()=>{
    mindplotComponent.current.buildDesigner();
    mindplotComponent.current.loadMap("map_id");
  }, [])

  return (<div>
    <mindplot-component
        ref={mindplotComponent}
        id="mindmap-comp"
        mode={options.mode}
      ></mindplot-component>
  </div>);
}

Check out the examples located in test/playground/map-render/js for some hints on high level usage. You can browse them by running yarn playground.

Readme

Keywords

none

Package Sidebar

Install

npm i @gip-recia/wisemapping-mindplot

Weekly Downloads

26

Version

6.0.0-recia-1.0.2405231

License

none

Unpacked Size

597 kB

Total Files

161

Last publish

Collaborators

  • indahjul
  • jgribonvald
  • nathan.cailbourdin
  • pierre.legay
  • quentin-guillemin