search

process-analytics / bpmn-visualization-js

A TypeScript library for visualizing process execution data on BPMN diagrams
https://process-analytics.github.io/bpmn-visualization-js/
Apache License 2.0
224 stars 31 forks source link

[DOC] Review the 'inherit' and 'swimlane' color #2587

Closed tbouffard closed 1 year ago

tbouffard commented 1 year ago

These are 2 special mxGraph keywords that can be set in color style properties. The documentation is quite vague about their purpose

They were initially mentioned in the JSDoc of the "Update Style" API, but they have been finally removed due to a lack of impacts of such values. See https://github.com/process-analytics/bpmn-visualization-js/pull/2585#discussion_r1140035143

The goal of this issue is to investigate the effects of these values when using the "Update Style API or when using them in the mxGraph style definition. Depending on the results of the investigation, we will decide to add them back to the documentation or not. Notice that the values were tested as part of #2539.

mxGraph information

https://github.com/jgraph/mxgraph/blob/v4.2.2/javascript/src/js/view/mxGraph.js#L222-L229

Inheriting Styles: For fill-, stroke-, gradient-, font- and indicatorColors special keywords can be used. The inherit keyword for one of these colors will inherit the color for the same key from the parent cell. The swimlane keyword does the same, but inherits from the nearest swimlane in the ancestor hierarchy. Finally, the indicated keyword will use the color of the indicator as the color for the given key.

csouchet commented 1 year ago

To test on boundary event or element of subprocess in the identification page.

csouchet commented 1 year ago

Verify if none & transparent are in all docs.