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.

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

Jump to bottom

[FEAT] Update API to display BPMN Elements with Overlays #27

Merged
merged 4 commits into from
Aug 30, 2021
Merged

[FEAT] Update API to display BPMN Elements with Overlays #27

merged 4 commits into from
Aug 30, 2021

Conversation

csouchet
Copy link
Member

@csouchet csouchet commented Aug 27, 2021 •
edited
Loading

Closes #9

@csouchet csouchet added depends on another PR ⚠️ Pull request depending on another one. The depending must be merged first enhancement New feature or request labels Aug 27, 2021
@csouchet csouchet force-pushed the 9-Add_API_to_display_Overlays_on_BPMN_Elements branch 2 times, most recently from 36af1f2 to 523bafc Compare August 30, 2021 09:55
@tbouffard tbouffard added the rebase needed 💥 Pull request that must be rebased on the latest master commit prior being reviewed or merged label Aug 30, 2021
@csouchet csouchet force-pushed the 9-Add_API_to_display_Overlays_on_BPMN_Elements branch from 523bafc to f9f3f10 Compare August 30, 2021 11:47
@csouchet csouchet removed depends on another PR ⚠️ Pull request depending on another one. The depending must be merged first rebase needed 💥 Pull request that must be rebased on the latest master commit prior being reviewed or merged labels Aug 30, 2021
@csouchet csouchet force-pushed the 9-Add_API_to_display_Overlays_on_BPMN_Elements branch from f9f3f10 to c0ca7d1 Compare August 30, 2021 11:49
tbouffard
tbouffard reviewed Aug 30, 2021
View reviewed changes
R/bpmnVisualization.R Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@csouchet csouchet marked this pull request as ready for review August 30, 2021 12:01
@csouchet csouchet changed the title [FEAT] Add API to display Overlays on BPMN Elements [FEAT] Update API to display Overlays on BPMN Elements Aug 30, 2021
@csouchet csouchet changed the title [FEAT] Update API to display Overlays on BPMN Elements [FEAT] Update API to display BPMN Elements with Overlays Aug 30, 2021
@tbouffard
Copy link
Member

Prior 96b272e, the BPMN diagram wasn't displayed anymore: the R binding had changed (pass an object instead of only the bpmn content) and the JS binding hadn't been updated. So the bpmn input passed to bpmn-visualization was empty and a alert window was displayed with the "parsing error".

This is now working, I have tested the display with

bpmn_file <- system.file("examples/Travel_Booking.bpmn", package = "bpmnVisualization")
bpmnVisualization::display(bpmn_file)

I have been able to display an overlay by following the README explanations

overlays <- list(bpmnVisualization::create_overlay("_6-203", "9"))
bpmnVisualization::display(bpmn_file, overlays)

image

Note about robustness
If a list is not provided for the overlays but a single overlay, there is no error but the overlay is not displayed.
For instance, with the following

> overlays <- bpmnVisualization::create_overlay("_6-203", "9")
> bpmnVisualization::display(bpmn_file, overlays)

@tbouffard tbouffard mentioned this pull request Aug 30, 2021
Closed
@csouchet csouchet merged commit 133d8fe into main Aug 30, 2021
@csouchet csouchet deleted the 9-Add_API_to_display_Overlays_on_BPMN_Elements branch August 30, 2021 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tbouffard tbouffard tbouffard approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEAT] Add API to display Overlays on BPMN Elements
2 participants
@csouchet @tbouffard