Giter Club home page Giter Club logo

camunda-bpmn.js's Introduction

camunda-bpmn.js

camunda BPMN Javascript libraries for parsing, executing and rendering BPMN 2.0 with Java Script.

Components

  • Transformer - Supports parsing a BPMN 2.0 Xml File and transforming it into a Java Script object model. The same object model can then be passed to the Executor and the Renderer.
  • Executor - Lightweight Process Engine completely written in Java Script.
  • Renderer - Allows rendering BPMN 2.0 Diagrams using SVG or HTML5 Canvas.

Getting Started

The entry point to the API is the Bpmn Class.

Bootstrapping the Renderer

The Renderer uses dojo gfx for abstracting SVG and HTML5 Canvas as underlying graphics technology.

You must first include the dojo bootstrap library:

<script src="lib/dojo/dojo/dojo.js"
  data-dojo-config="async: true, parseOnLoad: true, forceGfxRenderer: 'svg'">
</script>

Now you can asynchronously load all required libraries. Assuming that the dojo distribution is located under lib and camunda-bpmn.js is located under src/:

require({
  baseUrl: "./",
  packages: [
    { name: "dojo", location: "lib/dojo/dojo" },
    { name: "dojox", location: "lib/dojo/dojox"},
    { name: "bpmn", location: "src/bpmn"}]
});

And finally load & render the process diagram

require(["bpmn/Bpmn", "dojo/domReady!"], function(Bpmn) {
  new Bpmn().renderUrl("test/resources/task_loop.bpmn", {
    diagramElement : "diagram",
    overlayHtml : '<div style="position: relative; top:100%"></div>'
  }).then(function (bpmn){
    bpmn.zoom(0.8);
    bpmn.annotate("reviewInvoice", '<span class="bluebox"  style="position: relative; top:100%">New Text</span>', ["highlight"]);
  });
});

camunda-bpmn.js's People

Contributors

meyerdan avatar adrobisch avatar nikku avatar jakobfreund avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.