maxGraph/README.md

39 lines
2.8 KiB
Markdown
Raw Normal View History

2012-05-21 20:19:38 +00:00
mxgraph
2012-05-21 20:53:44 +00:00
=======
2017-05-29 21:27:19 +00:00
mxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering. [draw.io](https://www.draw.io) is an example that extends the functionality of this library. The [sources to draw.io](https://github.com/jgraph/draw.io) are also available.
2012-05-21 20:53:44 +00:00
2018-01-20 15:32:07 +00:00
Note this is the release repo. The development repo is on [Bitbucket](https://bitbucket.org/jgraph/mxgraph2). Submit PRs there.
2017-12-13 14:34:45 +00:00
2017-02-27 16:13:53 +00:00
If you want to build something like draw.io, [GraphEditor](https://jgraph.github.io/mxgraph/javascript/examples/grapheditor/www/index.html) is the best example to use as a base.
2018-01-20 15:32:07 +00:00
The npm build is [here](https://www.npmjs.com/package/mxgraph), but it's not supported. We don't use NPM, nor care about it. Do not submit issues complaining about it being broken, they will be closed. You are welcome to submit PRs to fix any issues.
mxGraph is a 12+ year old project, we won't bend it to fit the latest fad framework, module system, other. They'll all be dead in 2 years and require a re-write, so don't bother submitting issues asking for fadX to be supported.
That said, if you insist on wasting your time on fadX, mxGraph is open source, we encourage you to fork and replace this project (in fact we challenge you to). So far there's [monsterGraph](https://github.com/stalkerg/monstergraph) (which looks dead) and [jjgraph](https://github.com/jonjomckay/jjgraph).
2017-03-10 20:24:40 +00:00
2017-01-09 12:02:05 +00:00
mxGraph supports IE 11, Chrome 32+, Firefox 38+, Safari 7.1.x, 8.0.x, 9.1.x and 10.0.x, Opera 20+, Native Android browser 5.1.x+, the default browser in the current and previous major iOS versions (e.g. 10.x and 9.x) and Edge 23+.
2013-01-11 13:30:18 +00:00
2017-05-29 21:26:26 +00:00
mxGraph uses no third-party software, it requires no plugins and can be integrated in virtually any framework.
2013-01-11 13:30:18 +00:00
2013-01-11 12:34:48 +00:00
Getting Started
===============
2016-09-06 14:06:20 +00:00
In the root folder there is an index.html file that contains links to all resources. You can view the documentation online on the [Github pages branch](https://jgraph.github.io/mxgraph/). The key resources are the JavaScript user manual, the JavaScript examples and the JavaScript API specificiation.
2013-01-11 12:34:48 +00:00
Support
=======
2018-01-20 15:32:07 +00:00
There is a [mxgraph tag on Stack Overflow](http://stackoverflow.com/questions/tagged/mxgraph). Please ensure your questions adhere to the [SO guidelines](http://stackoverflow.com/help/on-topic), otherwise it will be closed.
2017-10-18 22:31:13 +00:00
2017-02-27 16:13:53 +00:00
License
=======
mxGraph is licensed under the Apache 2.0 license. We do not sell any other license, nor do we have an option for paid support.
History
=======
2017-06-27 12:57:57 +00:00
We created mxGraph in 2005 as a commercial project and it ran through to 2016 that way. Our USP was the support for non-SVG browsers, when that advantage expired we moved onto commercial activity around draw.io. mxGraph is pretty much feature complete, production tested in many large enterprises and stable for many years. We actively fix bugs and make minor improvements since it comprises the base of our draw.io stack.