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

docs(StyleByNamePlugin): mention the match of several elements #314

Merged
merged 1 commit into from
Oct 2, 2024
Merged

docs(StyleByNamePlugin): mention the match of several elements #314

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion packages/addons/src/plugins/style.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,13 @@ export interface StyleRegistryByName extends StyleRegistry {
/**
* Provide style operations on BPMN elements, identifying them by name.
*
* This plugin is a wrapper that delegates the actual style operations to {@link BpmnElementsRegistry}.
* This plugin is a wrapper that delegates the actual style operations to a {@link StyleRegistry} instance.
* It uses the {@link BpmnElementsSearcher} to map names to ids.
*
* **WARNING**: This plugin does not currently allow you to configure deduplication or filtering of the elements corresponding to the names supplied as method parameters.
* If a name corresponds to multiple elements, all matching elements are used, as implemented in {@link BpmnElementsSearcher.getElementsByNames}.
* This is a known limitation of the current implementation.
*
* **IMPORTANT**: The mapping is currently not cached, nor pre-fetched after the BPMN source has been loaded.
* So the implementation is not very effective. Caching and pre-fetch features will be implemented in the future.
* See https://github.com/process-analytics/bpmn-visualization-addons/issues/4 for improvement.
Expand Down
Loading