feat(partition): order slices and sectors

[monfera]

Summary

Adds slice sorting for the use of pie charts and sunburst, which allows

• placing a supplied "Other" slice to be placed at the end, even if, as in this example, the "Other" slice is larger than a regular slice
• slice sorting eg. when the partitioning is along an ordinal variable
• can be used for alphabetical sorting too, though it's almost always a practice to avoid

Precondition for mosaic plot #1113
Closes #1012
Contributes toward elastic/kibana#90179
Partially addresses #381

The newly introduced sortPredicate is for a sort predicate that compares order of any given two ArrayEntry objects. ArrayEntry has already been part of the public API, so we don't need to publish a new data type for this.

Checklist

Delete any items that are not applicable to this PR.

• Any consumer-facing exports were added to src/index.ts (and stories only import from ../src except for test data & storybook)
• This was checked for cross-browser compatibility
• Proper documentation or storybook story was added for features that require explanation or tutorials
• Unit tests were updated or added to match the most common scenarios

[monfera]

jenkins please test this

[codecov-io]

Codecov Report

Merging #1112 (954dfb8) into master (ec17cb2) will increase coverage by 0.44%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1112      +/-   ##
==========================================
+ Coverage   72.03%   72.47%   +0.44%     
==========================================
  Files         381      397      +16     
  Lines       11919    12244     +325     
  Branches     2601     2651      +50     
==========================================
+ Hits         8586     8874     +288     
- Misses       3308     3337      +29     
- Partials       25       33       +8     

Flag	Coverage Δ
unittests	72.05% <100.00%> (+0.02%)	⬆️

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

Impacted Files	Coverage Δ
src/utils/accessor.ts	81.81% <ø> (ø)
src/utils/common.ts	86.16% <ø> (ø)
...es/partition_chart/layout/utils/group_by_rollup.ts	88.00% <100.00%> (+0.12%)	⬆️
...hart_types/partition_chart/layout/utils/treemap.ts	98.57% <100.00%> (+0.06%)	⬆️
...tion_chart/layout/viewmodel/hierarchy_of_arrays.ts	100.00% <100.00%> (ø)
...ypes/partition_chart/layout/viewmodel/viewmodel.ts	85.08% <100.00%> (ø)
src/chart_types/partition_chart/specs/index.ts	53.84% <100.00%> (ø)
src/mocks/scale/index.ts	100.00% <0.00%> (ø)
src/mocks/scale/scale.ts	77.77% <0.00%> (ø)
src/mocks/series/utils.ts	100.00% <0.00%> (ø)
... and 13 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ec17cb2...954dfb8. Read the comment docs.

[stratoula]

@monfera it seems fine to me. What I want is:

• sort by the metric (numeric). I think that I can do it by just changing the clockWiseoption.
• sort alphabetically if the user requests it (will use the new sortPredicate for that)

@flash1293 I think it is fine for Lens too. wdyt?

[monfera]

@stratoula correct, and if you need special sorting, eg. you want to put the "Other" slice to the end, even if it's not the smallest slice, then you can rely on the sortPredicate too

[markov00]

Tested locally with configurations of specialFirstInnermostSector , clockwiseSectors and legend. Works as expected

[flash1293]

Didn't test the code, but the API looks good to me - a function will give full flexibility which can be use to look up the row index the data table for "user defined" sorting

[monfera]

Thanks @markov00 for the review and for @stratoula and @flash1293 for looking at the API. I ended up merging relatively fast as this doesn't lock us in anyway, if there's post-merge or integration time feedback to act upon, and it clears the baseline for the upcoming partition related PRs (lower risk of merge conflict)

[nickofthyme]

🎉 This PR is included in version 28.1.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀