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

[FEAT] Let remove all overlays of several BPMN elements at once #2577

Open
tbouffard opened this issue Mar 13, 2023 · 0 comments
Open

[FEAT] Let remove all overlays of several BPMN elements at once #2577

tbouffard opened this issue Mar 13, 2023 · 0 comments
Labels
BPMN diagram overlays Overlays: positioning, shapes, functionality enhancement New feature or request

Comments

@tbouffard
Copy link
Member

tbouffard commented Mar 13, 2023

Is your feature request related to a problem? Please describe.
Currently, in version 0.32.0, we can remove all overlays of one single element.

When an application needs to remove overlays of several BPMN elements, it must loop over a list of ids.
So, the application integrating bpmn-visualization must keep track of this ids where it previously added overlays.
As in #2576, this is particularly overwhelming when the application needs to clean the whole overlays to restore the default rendering, or propose a complete different visualization. For instance, to switch from a monitoring view to a conformance view.

We already see the loop cleanup in several repositories of the Process Analytics project:

Describe the solution you'd like
Update the existing API to remove all overlays on a single element, several elements or all elements (full cleanup).

Switch from

removeAllOverlays(bpmnElementId: string): void 

to

removeAllOverlays(bpmnElementIds?: string | string[]): void 

Calling the method without argument will remove all overlays on all elements.
This signature matches the removeAllCssClasses signature (see #2576).

Additional context

Passing an empty array or an empty string should have no effect. See #2900

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BPMN diagram overlays Overlays: positioning, shapes, functionality enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants