https://github.com/bpmn-io/align-to-origin

Nicely align your diagrams to the coordinate origin.
https://github.com/bpmn-io/align-to-origin

bpmn-js cmmn-js diagram-js dmn-js

Last synced: 3 months ago
JSON representation

Nicely align your diagrams to the coordinate origin.

• Host: GitHub
• URL: https://github.com/bpmn-io/align-to-origin
• Owner: bpmn-io
• License: mit
• Created: 2019-02-08T07:45:32.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T09:52:10.000Z (7 months ago)
• Last Synced: 2024-07-04T02:34:36.874Z (4 months ago)
• Topics: bpmn-js, cmmn-js, diagram-js, dmn-js
• Language: JavaScript
• Homepage:
• Size: 786 KB
• Stars: 3
• Watchers: 8
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-bpmn-io - @bpmn-io/align-to-origin - Aligns your diagrams to the coordinate origin, manually triggered or on diagram save (Extensions)

README

        
# @bpmn-io/align-to-origin

[![CI](https://github.com/bpmn-io/align-to-origin/workflows/CI/badge.svg)](https://github.com/bpmn-io/align-to-origin/actions?query=workflow%3ACI)

Aligns your diagrams to the coordinate origin `(0,0)`, manually triggered or on diagram save.

Plugs into your favorite [BPMN](https://github.com/bpmn-io/bpmn-js), [DMN](https://github.com/bpmn-io/dmn-js) and [CMMN](https://github.com/bpmn-io/cmmn-js) editor.



_Alignment in action. [Diagram origin marker](https://github.com/bpmn-io/diagram-js-origin), alignment corridor, and element boxes shown for demonstration purposes only._

## Usage

```javascript

import BpmnModeler from 'bpmn-js/lib/Modeler';

import AlignToOrigin from '@bpmn-io/align-to-origin';

// extend the BPMN editor with the exporter module

const modeler = new BpmnModeler({

  alignToOrigin: {

    alignOnSave: true,

    offset: 150,

    tolerance: 50

  },

  additionalModules: [

    AlignToOrigin

  ]

});

// hooks into #saveXML to align the diagram elements

modeler.saveXML(function(err, xml) {

  ...

});

// may be used standalone, too

const alignToOrigin = modeler.get('alignToOrigin');

alignToOrigin.align();

```

## License

MIT