feat(sankey): Show values

[sidharthv96]

📑 Summary

Show values with sankey diagrams.

Resolves #4674

📏 Design Decisions

Currently, I've added prefix and suffix as config options, but I doubt that's the best approach.

Either, we should support all config values in the frontmatter, which would be a big change.
Or, we could add support for prefix and suffix into the grammar. (Which we can add/remove as sankey is still in beta).

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added necessary unit/e2e tests.
• 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
• 🔖 targeted develop branch

[codecov]

Codecov Report

Merging #4748 (ce6992e) into develop (adfed1e) will increase coverage by 29.75%.
The diff coverage is 15.38%.

Additional details and impacted files

@@             Coverage Diff              @@
##           develop    #4748       +/-   ##
============================================
+ Coverage    45.55%   75.31%   +29.75%     
============================================
  Files           53      146       +93     
  Lines         6629    14569     +7940     
  Branches        32      592      +560     
============================================
+ Hits          3020    10972     +7952     
+ Misses        3608     3478      -130     
- Partials         1      119      +118     

Flag	Coverage Δ
e2e	81.53% <15.38%> (?)
unit	45.55% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
packages/mermaid/src/diagrams/sankey/sankeyDB.ts	91.66% <ø> (ø)
...ages/mermaid/src/diagrams/sankey/sankeyRenderer.ts	74.19% <15.38%> (ø)

... and 140 files with indirect coverage changes

[sidharthv96]

Should we follow pie convention and add a showData option in the grammar?
Something like showData("$", "B") could handle the prefix and suffix as well.

showData could be showValues too.

Using grammar

sankey-beta

%% Don't show values. Values will be shown by default.
hideData

%% Prefix and suffix
showData("$", "B")

%% Prefix only
showData("$", "")
showData("$")

%% Suffix only
showData("", "Tons")

Using frontmatter

---
config:
  sankey:
    prefix: $
    suffix: B 
---
sankey-beta

[Yokozuna59]

@sidharthv96 I agree on adding it grammar, although it won't be simple CSV style.

But the suggested sample code is kind of weird; although it can easily stick in your mind when it has been mentioned in the documentation, I don't think users would get the idea from just looking at the code.

If we couldn't find a cleaner way I'd suggest just adding to config instead of making grammar weird.