Skip to content

docs: integrate contents from the mxGraph Java manual #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tbouffard merged 2 commits into from
Jan 7, 2025
Merged

docs: integrate contents from the mxGraph Java manual #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b38bc2
docs: integrate contents from the mxGraph Java manual
tbouffard Jan 7, 2025
0879209
fix typo and add links
tbouffard Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions packages/website/docs/manual/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,23 @@ Being a developer library, `maxGraph` is not designed specifically to provide a
`maxGraph` provides all the commonly required functionality to draw, interact with and associate a context with a diagram.
`maxGraph` comes with a number of examples that help explain how a basic application is put together and showcases individual features of the library.

Developers integrating the library in their application should read the section “Pre-requisites” below.
Given that `maxGraph` is a component part of your application, you must understand how JavaScript web applications are constructed at an architectural level, and how to program both in JavaScript, and any server-side languages used.
Developers integrating the library in their application should read the section ["Pre-requisites" below](#pre-requisites-for-maxgraph).
Given that `maxGraph` is a component of your application, you must understand how JavaScript web applications are constructed at an architectural level, and how to program both in JavaScript, and any server-side languages used.

`maxGraph` mainly comprises one JavaScript file that contains all the `maxGraph` functionality. This is loaded into an HTML web page in a JavaScript section and executes in an HTML container in the browser.
This is an incredibly simple architecture that only requires a web server capable of serving html pages and a JavaScript enabled web browser.

The key advantages of this technology are:
- That no third-party plug-ins are required. This removes plug-in vendor dependence.
- The technologies involved are open and there are many open implementations, no one vendor can remove a product or technology that leaves your application unworkable in practise.
- The technologies involved are open and there are many open implementations, no vendor can remove a product or technology that leaves your application unworkable in practise.
- Standardized technologies, meaning your application is deployable to the maximum number of browser users without need for additional configuration or installation at the client computer.
Large corporate environments often dislike allowing individuals to install browser plug-ins and do not like to change the standard build rolled out to all machines.

The key disadvantage of this technology is:
- Rendering speed. As the number of cells visible on the user's screen climbs into the hundreds, redrawing slows on most browsers beyond acceptable levels.
In information management theory displaying several hundred cells is generally incorrect, since the user cannot interpret the data.
There are a number of mechanisms, collectively known as complexity management used to limit the amount of information to sensible levels, and thus maintaining reactive redraw rates for the user.
Complexity management is described in [a later section](group-and-complexity-management.md#complexity-management) of this user manual.

<a id="mxgraph_applications"></a>
## What Applications can `maxGraph` be used for?
Expand Down
Binary file removed packages/website/old-mxgraph/images/mx_man_stencil_loaded.png
View file
Open in desktop
Binary file not shown.
Loading