Skip to content
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.

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

[DOC] architecture additions #269

Merged
merged 16 commits into from
May 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/architecture/00-index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@
To know how to build the project, please have a look at the https://github.com/process-analytics/bpmn-visualization-js/blob/master/CONTRIBUTING.md[contributing guide].


include::architecture-overview.adoc[]

include::bpmn-internal-model.adoc[]

include::bpmn-parsing.adoc[]

include::mxgraph-integration.adoc[]

include::bpmn-support-how-to.adoc[]
9 changes: 9 additions & 0 deletions docs/architecture/architecture-overview.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
=== Architecture Overview

The lib consists on 2 main modules

* parsing: read a BPMN source (xml string) and convert it into its own link:bpmn-internal-model.adoc[internal Model]
* rendering: display the BPMN diagrams represented by the internal Model, using the https://jgraph.github.io/mxgraph/[mxGraph library]

image::images/architecture/architecture_overview.svg[]

4 changes: 2 additions & 2 deletions docs/architecture/bpmn-support-how-to.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ flow` support (see `ShapeBpmnElementKind` for more details)
* Add end-to-end tests, mainly to ensure that the new BPMN element is now stored in the `mxGraph model`, see `mxGraph.model.test.ts`.
* No need to create specific XML tests, the XML parsing is tested globally using BPMN files for various BPMN vendors.


[[bpmn-support-howto-elements-rendering]]
==== Elements rendering

When inserting an element on the graph, a style is passed to identify the way it will be rendered.
When inserting an element on the `mxGraph` graph, a style is passed to identify the way it will be rendered.

The https://jgraph.github.io/mxgraph/docs/js-api/files/view/mxStylesheet-js.html[style] is defined and registered in
`StyleConfigurator`. In particular, it refers to the name of a https://jgraph.github.io/mxgraph/docs/js-api/files/shape/mxShape-js.html[mxShape]
Expand Down
Loading