Commit Graph

3 Commits (fd0d47ad4a5f4d471eef7109aa7fca52db198f13)

Author SHA1 Message Date
Thomas Bouffard 926596722c
docs: improve the mxGraph migration guide (#206)
Added paragraphs
  - classes renames
  - moved methods
  - how-to migrating styles

---------

Co-authored-by: Souchet Céline <celine.souchet@bonitasoft.com>
2023-06-19 15:28:15 +02:00
Thomas Bouffard 1447fd29fc
docs: reorganize the "migration from mxGraph" documentation (#171)
Move everything from the README to the dedicated migration doc.
Clarify the existing content.

Co-authored-by: Souchet Céline <4921914+csouchet@users.noreply.github.com>
2023-01-30 15:01:55 +01:00
Thomas Bouffard ca1914b582
refactor(style)!: rename/remove properties and types (#165)
Remove the `StyleMap` class. It is not used anymore since the
introduction of the `CellStateStyle` interface.

Changes in `CellStateStyle`
- remove `defaultEdge` and `defaultVertex` that have been introduced by
mistake. They have never been used.
- rename `autosize` into `autoSize` for naming consistency. All
properties use camelCase.
- change types from "number" to "boolean" + fix default management in
the Shape classes
    - `backgroundOutline`
    - `absoluteArcSize`

Other `CellStateStyle` changes: remove a property in favor of another
property
The following properties were introduced by mistake while removing
mxConstants.STYLE_* references in
707605cedd (2021-05-02). Their counterpart
was used in `mxGraph` and is used in all
`maxGraph` examples
- `backgroundColor` in favor of `labelBackgroundColor`. The
`STYLE_LABEL_BACKGROUNDCOLOR` constant was replaced by
  'backgroundColor' instead of 'labelBackgroundColor'
- `loop` in favor of `loopStyle`. The `STYLE_LOOP` constant was replaced
by 'loop' instead of 'loopStyle'

Other types that changed
- `CellStateStyle`: better type guidance for the `indicatorShape`
property
- `CanvasState`: order properties alphabetically + add JSDoc on some
properties
- Rename `ArrowType` into `ArrowValue` for consistency with other types
(they all end with the 'Value' post-fix)

Documentation update
  - CHANGELOG.md: mention the breaking changes
- Initiate a specific document to help migration from mxGraph: start by
adding the changes on style


--------------------------------------------------------------------------------

**BREAKING CHANGES**: some `CellStateStyle` properties and types have
been removed/renamed.
2023-01-30 11:44:06 +01:00