https://github.com/bpmn-io/bpmn-to-image

Convert BPMN 2.0 diagrams to PDF documents or PNG files.
https://github.com/bpmn-io/bpmn-to-image

bpmn bpmn-to-image

Last synced: 3 months ago
JSON representation

Convert BPMN 2.0 diagrams to PDF documents or PNG files.

• Host: GitHub
• URL: https://github.com/bpmn-io/bpmn-to-image
• Owner: bpmn-io
• Created: 2018-04-20T07:40:28.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-05-13T11:55:53.000Z (6 months ago)
• Last Synced: 2024-07-21T13:14:38.568Z (4 months ago)
• Topics: bpmn, bpmn-to-image
• Language: JavaScript
• Homepage:
• Size: 154 KB
• Stars: 58
• Watchers: 10
• Forks: 36
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome-bpmn-io - bpmn-to-image - Transform BPMN diagrams to images from the command line (Extensions)

README

        
# bpmn-to-image

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

Convert [BPMN 2.0 diagrams](https://www.omg.org/spec/BPMN/2.0) to PDF documents, SVG or PNG files.

## Usage

This package exposes the `bpmn-to-image` command line utility that allows you to convert BPMN 2.0 diagrams to PNG and PDF documents:

```bash

$ bpmn-to-image --help

  Convert a BPMN 2.0 diagrams to PDF or PNG images

  Usage

    $ bpmn-to-image : ...

  Options

    diagramFile                    Path to BPMN diagram

    outputConfig                   List of extension or output file paths

    --min-dimensions=  Minimum size in pixels (x)

    --title=                Add explicit  to exported image

    --no-title                     Don't display title on exported image

    --no-footer                    Strip title and logo from image

    --scale                        Scale factor for images (1)

  Examples

    # export to diagram.png

    $ bpmn-to-image diagram.bpmn:diagram.png

    # export diagram.png, diagram.svg and /tmp/diagram.pdf

    $ bpmn-to-image diagram.bpmn:diagram.png,diagram.svg,/tmp/diagram.pdf

    # export with minimum size of 500x300 pixels

    $ bpmn-to-image --min-dimensions=500x300 diagram.bpmn:png

```

## Embedding

You may embed [bpmn-to-image](https://github.com/bpmn-io/bpmn-to-image) and use it as parts of your application:

```javascript

const {

  convertAll

} = require('bpmn-to-image');

await convertAll([

  {

    input: 'diagram.bpmn',

    outputs: [

      'diagram.pdf',

      'diagram.png'

      'diagram.svg'

    ]

  }

]);

```

This renders the BPMN diagram using [bpmn-js](https://github.com/bpmn-io/bpmn-js) and exports it to the specified output files using [Puppeteer](https://github.com/GoogleChrome/puppeteer).

## Install

```bash

npm install -g bpmn-to-image

```

## License

MIT