maxGraph/README.md

mxGraph
=======

mxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering. [diagrams.net](https://app.diagrams.net) is our production-grade example that demonstrates extending the functionality of this library and how to deploy it in a secure, scalable manner. The [sources to diagrams.net](https://github.com/jgraph/draw.io) are also available.

Note this is the release repo, only each release is pushed here. The development repo is https://github.com/jgraph/mxgraph2,  submit PRs there.

The PHP model was deprecated after release 4.0.3 and the archive can be found [here](https://github.com/jgraph/mxgraph-php).

If you want to build something like diagrams.net, [GraphEditor](https://jgraph.github.io/mxgraph/javascript/examples/grapheditor/www/index.html) is the best example to use as a base.

The npm build is [here](https://www.npmjs.com/package/mxgraph)

We don't support Typescript, but there is a [project to implement this](https://github.com/process-analytics/mxgraph-road-to-DefinitelyTyped), with [this repo](https://github.com/hungtcs/mxgraph-type-definitions) currently used as the lead repo.

mxGraph supports IE 11, Chrome 43+, Firefox 45+, Safari 10 and later, Opera 30+, Native Android browser 5.1.x+, the default browser in the current and previous major iOS versions (e.g. 13.x and 12.x) and Edge 31+.

The mxGraph library uses no third-party software, it requires no plugins and can be integrated in virtually any framework (it's vanilla JS).

Getting Started
===============

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.

Support
=======

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 is likely to be closed.

You may post on the issues tracker on this Github project, but we do not actively answer support questions. Issue most likely to interest us at clearly explained bugs in the core library and pull requests with a clear explaination of what they are fixing and how.

We do not support the .NET and Java rendering functionality at all, the source code is just included in the repo for completeness. Non JavaScript rendering questions will be closed and pointed at this README.

If you are looking for active support, your better route is one of the commercial diagramming tools, like yFiles or GoJS.

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
=======

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 add features specific to our needs in diagrams.net.
Updates 2019-10-09 16:46:15 +00:00			`mxGraph`
Updated with links 2012-05-21 20:53:44 +00:00			`=======`

Update README.md 2020-07-01 20:32:24 +00:00			`mxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering. [diagrams.net](https://app.diagrams.net) is our production-grade example that demonstrates extending the functionality of this library and how to deploy it in a secure, scalable manner. The [sources to diagrams.net](https://github.com/jgraph/draw.io) are also available.`
Updated with links 2012-05-21 20:53:44 +00:00
Update README.md 2019-10-11 16:45:39 +00:00			`Note this is the release repo, only each release is pushed here. The development repo is https://github.com/jgraph/mxgraph2, submit PRs there.`
Update README.md 2017-12-13 14:34:45 +00:00
Update README.md 2019-08-20 12:16:39 +00:00			`The PHP model was deprecated after release 4.0.3 and the archive can be found [here](https://github.com/jgraph/mxgraph-php).`

Update README.md 2020-07-01 20:32:24 +00:00			`If you want to build something like diagrams.net, [GraphEditor](https://jgraph.github.io/mxgraph/javascript/examples/grapheditor/www/index.html) is the best example to use as a base.`
Update README.md 2017-02-27 16:13:53 +00:00
Update README.md 2018-02-26 11:53:32 +00:00			`The npm build is [here](https://www.npmjs.com/package/mxgraph)`
Update README.md 2017-03-10 20:24:40 +00:00
Update README.md 2020-06-07 08:01:58 +00:00			`We don't support Typescript, but there is a [project to implement this](https://github.com/process-analytics/mxgraph-road-to-DefinitelyTyped), with [this repo](https://github.com/hungtcs/mxgraph-type-definitions) currently used as the lead repo.`

Updates 2019-10-09 16:46:15 +00:00			`mxGraph supports IE 11, Chrome 43+, Firefox 45+, Safari 10 and later, Opera 30+, Native Android browser 5.1.x+, the default browser in the current and previous major iOS versions (e.g. 13.x and 12.x) and Edge 31+.`
Update README.md 2013-01-11 13:30:18 +00:00
Updates 2019-10-09 16:46:15 +00:00			`The mxGraph library uses no third-party software, it requires no plugins and can be integrated in virtually any framework (it's vanilla JS).`
Update README.md 2013-01-11 13:30:18 +00:00
Update README.md 2013-01-11 12:34:48 +00:00			`Getting Started`
			`===============`

Update README.md 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.`
Update README.md 2013-01-11 12:34:48 +00:00
			`Support`
			`=======`

Update README.md 2020-07-01 20:32:24 +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 is likely to be closed.`
Update README.md 2017-10-18 22:31:13 +00:00
Update README.md 2020-07-01 20:32:24 +00:00			`You may post on the issues tracker on this Github project, but we do not actively answer support questions. Issue most likely to interest us at clearly explained bugs in the core library and pull requests with a clear explaination of what they are fixing and how.`
Update README.md 2019-10-04 08:08:22 +00:00
Added comment regarding Java and .NET support 2019-11-27 22:49:11 +00:00			`We do not support the .NET and Java rendering functionality at all, the source code is just included in the repo for completeness. Non JavaScript rendering questions will be closed and pointed at this README.`

Update README.md 2020-07-01 20:32:24 +00:00			`If you are looking for active support, your better route is one of the commercial diagramming tools, like yFiles or GoJS.`

Update README.md 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`
			`=======`

Update README.md 2020-07-01 20:32:24 +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 add features specific to our needs in diagrams.net.`