Skip to content

bpmn-io/graphml-moddle

Repository files navigation

This library exposes ES modules. Use esm to consume it or a ES module aware transpiler such as Webpack, Rollup or Browserify + babelify to bundle it for the browser.

graphml-moddle

Build Status

Read and write GraphML 1.1 files in NodeJS and the browser.

Usage

Get the library via npm package. Bundle it for the web using your favorite module bundler.

import GraphmlModdle from 'graphml-moddle';

var moddle = new GraphmlModdle();

var modelXML = ...;

moddle.fromXML(modelXML, function(err, graphml) {

  // read graphs
  graphml.rootElements; // [ { $type: 'graphml:Graph', ... }, ... ]

  // read extensions
  graphml.extensions; // [ { $type: 'graphml:Key', ... }, ... ]

  // add a new graph
  const newGraph = moddle.create('graphml:Graph', {
    id: 'myGraph'
  });

  graphml.rootElements.push(newGraph);

  moddle.toXML(graphml, function(err, updatedXML) {

    // updatedXML contains new graph

  });

});

Resources

Building the Project

To run the test suite that includes XSD schema validation you must have a Java JDK installed and properly exposed through the JAVA_HOME variable.

Execute the test via

npm test

Perform a complete build of the library via

npm run all

Related Projects

License

Use under the terms of the MIT license.

About

Read and write GraphML 1.1 XML from JavaScript.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published