bpmn-to-image

    0.6.1 • Public • Published

    bpmn-to-image

    CI

    Convert BPMN 2.0 diagrams 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:

    $ bpmn-to-image --help
    
      Convert a BPMN 2.0 diagrams to PDF or PNG images
    
      Usage
    
        $ bpmn-to-image <diagramFile>:<outputConfig> ...
    
      Options
    
        diagramFile                    Path to BPMN diagram
        outputConfig                   List of extension or output file paths
    
        --min-dimensions=<dimensions>  Minimum size in pixels (<width>x<height>)
    
        --title=<title>                Add explicit <title> 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 and use it as parts of your application:

    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 and exports it to the specified output files using Puppeteer.

    Install

    npm install -g bpmn-to-image

    License

    MIT

    Install

    npm i bpmn-to-image

    DownloadsWeekly Downloads

    412

    Version

    0.6.1

    License

    MIT

    Unpacked Size

    14.2 kB

    Total Files

    6

    Last publish

    Collaborators

    • skaiir-camunda
    • marstamm
    • beatrizmendes
    • bpmn-io-admin
    • nikku
    • pinussilvestrus
    • barmac
    • philippfromme
    • maxtru