Skip to content

Releases: process-analytics/bpmn-visualization-R

0.5.0

19 Sep 05:29
Compare
Choose a tag to compare

This new version allows you to style the BPMN elements of the displayed diagram.

CRAN: this version is available on CRAN.

The bpmnVisualizationR package now uses [email protected].

Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard

See milestone 0.5.0 to get the list of issues covered by this release.

Highlights

Breaking changes

The way in which overlay styles are created has been simplified.

Previously, several functions had to be called to create the style elements:

taskStyle <- bpmnVisualizationR::create_style(
  fill = bpmnVisualizationR::create_fill(color = 'MistyRose'),
  font = bpmnVisualizationR::create_font(color = 'DarkSlateGray', size = 23),
  stroke = bpmnVisualizationR::create_stroke(color = 'Red')
),

These intermediate functions were removed (create_font, create_fill and create_stroke functions are now internal functions).
create_style has been renamed in create_overlay_style (for clarity and consistency with the new functions that let style BPMN elements), and now, you simply have to call this function to create the style of an overlay:

taskStyle <- bpmnVisualizationR::create_overlay_style(
  font_color = 'DarkSlateGray',
  font_size = 23,
  fill_color = 'MistyRose',
  stroke_color = 'Red'
)

ℹ️ For more details, see #245

New parameter to style BPMN Elements

The BPMN elements of the diagram can specificly be styled with the new create_shape_style and create_edge_style functions as shown below 👇🏿:

bpmnElementStyles <- list(
  bpmnVisualizationR::create_shape_style(
    elementIds = list("call_activity_1_1"),
    stroke_color = 'RoyalBlue',
    font_color = 'DarkOrange',
    font_family = 'Arial',
    font_size = 12,
    font_bold = TRUE,
    font_italic = TRUE,
    font_strike_through = TRUE,
    font_underline = TRUE,
    opacity = 75,
    fill_color = 'Yellow',
    fill_opacity = 50
  ),
  bpmnVisualizationR::create_edge_style(
    elementIds = list("sequence_flow_1_4"),
    stroke_color = 'DeepPink',
    stroke_width = 3,
    stroke_opacity = 70,
    font_color = 'ForestGreen',
    font_family = 'Courier New',
    font_size = 14,
    font_bold = TRUE,
    font_italic = TRUE,
    font_strike_through = FALSE,
    font_underline = FALSE,
    font_opacity = 80,
    opacity = 80
  )
)

bpmnVisualizationR::display(
  bpmn_file,
  bpmnElementStyles = bpmnElementStyles,
  width='auto',
  height='auto'
)

image

What's Changed

Full Changelog: v0.4.0...v0.5.0

🚀 Improvements

📝 Documentation

📦 Dependency updates

👻 Maintenance

0.4.0

03 Apr 13:45
Compare
Choose a tag to compare

This new version allows you to choose the style and position of the overlays.

IMPORTANT: this version is only available when installing from GitHub.

The bpmnVisualizationR package now uses [email protected].

Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard

See milestone 0.4.0 to get the list of issues covered by this release.

Highlights

Previously, the style and the position of the overlays were not configurable.

image

Now, it is also possible to change the position and the style of the overlays like in the following screenshot:

image

What's Changed

Full Changelog: v0.3.2...v0.4.0

🚀 Improvements

  • feat(overlay): allow to set the overlay position (#210) @csouchet
  • feat(overlay): allow to set the overlay style (#207) @csouchet

📝 Documentation

  • docs: add more examples for styles and positions of overlays (#218) @tbouffard
  • docs: update the documentation after CRAN publication (#205) @csouchet

📦 Dependency updates

👻 Maintenance

  • refactor(test): format and cut tests (#209) @csouchet
  • chore: ensure that the PR title follows "Conventional Commits" (#203) @tbouffard

0.3.2

20 Feb 13:08
Compare
Choose a tag to compare

This new version focuses on documentation improvements, mainly to meet CRAN requirements.
It is available at CRAN.

Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard

What's Changed

Full Changelog: v0.3.1...v0.3.2

  • chore: fix the update of the version in cran-comments.md in the release workflow (#199) @csouchet

📝 Documentation

  • fix: update the DESCRIPTION file and the R doc according last submission (#195) @csouchet
  • [DOC] Improve the release how-to (#193) @tbouffard

0.3.1

31 Jan 09:57
Compare
Choose a tag to compare

This new version focuses on documentation improvements, mainly to meet CRAN requirements.

The bpmnVisualizationR package now uses [email protected].

Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard

See milestone 0.3.1 to get the list of issues covered by this release.

What's Changed

Full Changelog: v0.3.0...v0.3.1

📝 Documentation

📦 Dependency updates

👻 Maintenance

  • [INFRA] Reduce the number of push during the release (#187) @tbouffard
  • [INFRA] Send a slack notification after release (#180) @csouchet
  • [INFRA] Fix the package renaming in the R-CMD-check workflow (#182) @csouchet

0.3.0

09 Jan 15:36
Compare
Choose a tag to compare

This new version brings a BREAKING CHANGE (new package name) and documentation improvements.

The bpmnVisualizationR package now uses [email protected].

Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard

See milestone 0.3.0 to get the list of issues covered by this release.

Highlights

⚠️⚠️⚠️ BREAKING CHANGE ⚠️⚠️⚠️

To avoid confusion with the bpmn-visualization TypeScript library, we decide to change the name of this package.

Old package name New package name
bpmnVisualization bpmnVisualizationR

To migrate to the newest version:

  • uninstall bpmnVisualization
  • install bpmnVisualizationR
  • update your R code by changing all functions prefixes from bpmnVisualization::xxx to bpmnVisualizationR::xxx

Documentation

The documentation is now available on the GitHub Pages 🎉

image

What's Changed

Full Changelog: v0.2.2...v0.3.0

📝 Documentation

📦 Dependency updates

👻 Maintenance

  • [REFACTOR] Rename the package as bpmnVisualizationR (#172) @csouchet
  • [INFRA] Simplify release announces (#174) @csouchet
  • [INFRA] Update the index.md file as part of the release process (#164) @tbouffard
  • [INFRA] Use the ubuntu-22.04 runner in all GitHub workflows (#168) @tbouffard

0.2.2

23 Nov 16:23
Compare
Choose a tag to compare

This new version makes improvements to the documentation, primarily to correct comments from the last attempt to submit to CRAN.

The R package now uses [email protected].

Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard

See milestone 0.2.2 to get the list of issues covered by this release.

What's Changed

Full Changelog: v0.2.1...v0.2.2

📝 Documentation

  • [DOC] Publish HTML documentation preview on surge (#128) @tbouffard
  • [DOC] Improve wording and fix typo in the CONTRIBUTING guide (#150) @tbouffard
  • [DOC] Update the license header in the JavaScript file (#148) @tbouffard
  • [DOC] Simplify the CRAN submission (#144) @tbouffard
  • [DOC] Improve the "Release Notes" writing steps (#143) @tbouffard
  • [DOC] Fix the documentation to better match CRAN requirements (#142) @csouchet

📦 Dependency updates

👻 Maintenance

0.2.1

17 Nov 10:32
0ec0a86
Compare
Choose a tag to compare

This new release focuses on maintenance. Thanks to @ColinFay for introducing automatic tests in the package.

The R package now uses [email protected].

Thanks to all the contributors of this release 🌈: @ColinFay, @csouchet and @tbouffard

What's Changed

Full Changelog: v0.2.0...v0.2.1

📝 Documentation

📦 Dependency updates

👻 Maintenance

0.2.0

30 Aug 08:40
79de624
Compare
Choose a tag to compare

This new release focuses on maintenance. The R package now uses [email protected].

Thanks to all the contributors of this release 🌈: @csouchet, @oanesini and @tbouffard

See milestone 0.2.0 to get the list of issues covered by this release.

What's Changed

Full Changelog: v0.1.2...v0.2.0

📝 Documentation

📦 Dependency updates

👻 Maintenance

  • [INFRA] Update wording in the GH WF bumping bpmn-visualization (#100) @tbouffard
  • [INFRA] Fix branch name in workflow updating bpmn-visualization (#81) @tbouffard
  • [INFRA] Improve usage of the r-lib action (#79) @tbouffard
  • [INFRA] Automate bpmn-visualization-js update (#34) @csouchet
  • [INFRA] Fix the milestone link in the release-drafter configuration (#75) @tbouffard

0.1.2

31 Mar 16:11
0ffdd83
Compare
Choose a tag to compare

This new release focuses on maintenance. The R package now uses [email protected].

Thanks to all the contributors of this release 🌈: @csouchet and @tbouffard

See milestone 0.1.2 to get the list of issues covered by this release.

What's Changed

🚀 Improvements

  • [EXAMPLE] Improve waypoints in the 'email voting' diagram (#71) @tbouffard

📝 Documentation

👻 Maintenance

📦 Dependency updates

  • [INFRA] gha - Bump actions/checkout from 2 to 3 (#69) @dependabot
  • [INFRA] gha - Bump actions/cache from 2 to 3 (#68) @dependabot
  • [INFRA] Bump 'bpmn-visualization' from 0.19.4 to 0.23.0 (#65) @csouchet

Full Changelog: v0.1.1...v0.1.2

0.1.1

21 Oct 08:40
f4bdae8
Compare
Choose a tag to compare

This new release focuses on documentation improvements and API robustness.
Many thanks to @alachambre who contributed to both topics 💖.

Thanks to all the contributors of this release 🌈: @alachambre, @csouchet and @tbouffard

See milestone 0.1.1 to get the list of issues covered by this release.

What's Changed

🚀 Improvements

  • [FEAT] Ensure overlays are passed as a list to the js function (#57) @alachambre

📝 Documentation

  • [DOC] Update the development documentation (#56) @csouchet
  • [DOC] Add a step to install devtools in the readme (#54) @alachambre
  • [DOC] Remove duplicated words in function documentation (#53) @alachambre
  • [DOC] Fix the documentation to create an overlay (#52) @csouchet
  • [DOC] Fix the link of the Code of conduct (#51) @csouchet

👻 Maintenance

📦 Dependency updates

  • [INFRA] Bump bpmn-visualization from 0.19.0 to 0.19.4 (#61) @tbouffard