feat(wordcloud): wordcloud by Kati-dev-hu · Pull Request #1038 · elastic/elastic-charts

Kati-dev-hu · 2021-02-28T18:03:07Z

Summary

Initial wordcloud implementation

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

kibanamachine · 2021-02-28T18:03:09Z

Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually?

cla-checker-service · 2021-02-28T18:03:10Z

💚 CLA has been signed

markov00 · 2021-03-05T10:42:50Z

Hi @Kati-dev-hu thanks so much for that, we really appreciate it!
I've played a bit with the examples and I've to say that it looks amazing!
I've compared it to the Kibana implementation and looks like we have nearly all required features. What is missing is the following:

the user can select the type of scale applied to each text weight: linear, log and square root are the options here.
There are some specific cases where, due to the applied constraints like the number of tags, font size, etc, some words are filtered out (you can try that just by reducing the width of the chart to a very small size). Kibana notify the user about that with a small icon over imposed on the chart with a tooltip

There can be several ways to achieve this, for now, it also fine living without it, but it will be great at least to have an internal logic that checks if all the words will be rendered or not. We can then use that somehow to expose that information to Kibana/other consumers

Anyway I think this already works very well and looks very clean, thanks for this big help!

Kati-dev-hu · 2021-03-09T19:44:35Z

Hi @markov00, thanks for your comments. Text weight is resolved, and the logic for missing words is coming up too, pushing commits soon

Kati-dev-hu · 2021-03-09T21:48:47Z

Commit pushed:
1/ warning in case not all words can be placed,
2/ text weight amongst knobs (weightFun):

# Conflicts: # .playground/playground.tsx # api/charts.api.md

codecov-io · 2021-03-21T21:24:34Z

Codecov Report

Merging #1038 (a0f5965) into master (588bdfa) will decrease coverage by 0.51%.
The diff coverage is 39.27%.

@@            Coverage Diff             @@
##           master    #1038      +/-   ##
==========================================
- Coverage   72.72%   72.20%   -0.52%     
==========================================
  Files         367      397      +30     
  Lines       11412    12058     +646     
  Branches     2479     2560      +81     
==========================================
+ Hits         8299     8707     +408     
- Misses       3098     3328     +230     
- Partials       15       23       +8

Flag	Coverage Δ
unittests	`71.77% <39.27%> (-0.95%)`	⬇️

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

Impacted Files	Coverage Δ
src/chart_types/index.ts	`100.00% <ø> (ø)`
...hart_types/wordcloud/layout/viewmodel/viewmodel.ts	`8.33% <8.33%> (ø)`
...pes/wordcloud/renderer/svg/connected_component.tsx	`19.16% <19.16%> (ø)`
...t_types/wordcloud/state/selectors/picked_shapes.ts	`20.00% <20.00%> (ø)`
...hart_types/wordcloud/state/selectors/scenegraph.ts	`35.71% <35.71%> (ø)`
...c/chart_types/wordcloud/state/selectors/tooltip.ts	`38.46% <38.46%> (ø)`
src/state/chart_state.ts	`87.17% <50.00%> (-0.98%)`	⬇️
...wordcloud/state/selectors/on_element_out_caller.ts	`53.33% <53.33%> (ø)`
...ordcloud/state/selectors/on_element_over_caller.ts	`53.33% <53.33%> (ø)`
...rdcloud/state/selectors/on_element_click_caller.ts	`56.25% <56.25%> (ø)`
... and 36 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 588bdfa...a0f5965. Read the comment docs.

monfera · 2021-03-21T21:40:28Z

jenkins test this please

monfera · 2021-03-21T22:18:06Z

jenkins test this please

markov00

Everything looks great, I've added few comments that we can easily fix on a subsequent PR.
Thank you very much for this great contribution!

markov00 · 2021-03-22T14:57:50Z

src/chart_types/wordcloud/layout/types/viewmodel_types.ts

+});
+
+/** @public */
+export type WeightFun = Values<typeof WeightFun>;


nit: Function is usually abbreviated as Fn

markov00 · 2021-03-22T15:15:09Z

src/chart_types/wordcloud/layout/types/viewmodel_types.ts

+  outOfRoomCallback: (wordCount, renderedWordCount) => {
+    Logger.warn(`Not all words have been placed: ${renderedWordCount} words rendered out of ${wordCount}`);
+  },


I'm not 100% sure about having that console log by default. We can probably have a no-op here

markov00 · 2021-03-22T15:17:09Z

src/chart_types/wordcloud/renderer/svg/connected_component.tsx

+  private tryCanvasContext() {
+    const canvas = this.props.forwardStageRef.current;
+    this.ctx = canvas && canvas.getContext('2d');
+  }
+
+  private drawCanvas() {
+    if (this.ctx) {
+      /*      const { width, height }: Dimensions = this.props.chartContainerDimensions;
+                renderCanvas2d(this.ctx, this.devicePixelRatio, {
+             ...this.props.geometries,
+             config: { ...this.props.geometries.config, width, height },
+           });
+      */
+    }
+  }


cam we completely remove the canvas element here and on the rendering? If we are not using it right now it's better to clean this up

markov00 · 2021-03-22T15:19:22Z

src/chart_types/wordcloud/state/chart_state.tsx

+  }
+
+  getTooltipInfo(globalState: GlobalChartState) {
+    return getTooltipInfoSelector(globalState);


The tooltip doesn't bring any new info as it is proposed today. We can easily disable it

Kati-dev-hu · 2021-03-22T20:15:29Z

Hi @markov00 Thanks for the review, I created the follow-up issue with these steps

# [25.4.0](v25.3.0...v25.4.0) (2021-03-23) ### Bug Fixes * chromium area path render bug ([#1067](#1067)) ([e16d15d](e16d15d)) ### Features * **tooltip:** expose datum in the TooltipValue ([#1082](#1082)) ([0246784](0246784)), closes [#1042](#1042) * **wordcloud:** wordcloud ([#1038](#1038)) ([f08f4c9](f08f4c9))

nickofthyme · 2021-03-23T14:40:12Z

🎉 This PR is included in version 25.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

# [25.4.0](elastic/elastic-charts@v25.3.0...v25.4.0) (2021-03-23) ### Bug Fixes * chromium area path render bug ([opensearch-project#1067](elastic/elastic-charts#1067)) ([37301bf](elastic/elastic-charts@37301bf)) ### Features * **tooltip:** expose datum in the TooltipValue ([opensearch-project#1082](elastic/elastic-charts#1082)) ([48dc9d5](elastic/elastic-charts@48dc9d5)), closes [opensearch-project#1042](elastic/elastic-charts#1042) * **wordcloud:** wordcloud ([opensearch-project#1038](elastic/elastic-charts#1038)) ([d724cad](elastic/elastic-charts@d724cad))

Kati-dev-hu added 2 commits February 19, 2021 11:23

chore: windows compat

e80d8dc

feat: wordcloud

cbae939

monfera added the wip work in progress label Feb 28, 2021

monfera marked this pull request as draft February 28, 2021 18:33

Kati-dev-hu added 8 commits February 28, 2021 22:38

fix: clean code

fb62d92

fix: console.log removed

214f7f7

fix: edit config changed, text replaced

e3ce642

fix: color palettes added

5d7816b

fix: new color palettes

ccf78b4

fix: new color palette and new config

e6f42cd

fix: background color configs

8c83f41

fix: random padding and color by word length

005cc31

feat: weight functions

8fb3c82

feat: count of placed words

05e9cc1

Kati-dev-hu force-pushed the wordcloud-wip branch 2 times, most recently from 61d147b to a1e9f2c Compare March 21, 2021 19:30

fix: type annotations

0cda284

Kati-dev-hu force-pushed the wordcloud-wip branch from a1e9f2c to 0cda284 Compare March 21, 2021 19:39

monfera added 6 commits March 21, 2021 21:13

feat: no room callback

392a23d

chore: more types

ef70a54

chore: api lint

eb3991f

test: story image

afed77f

Merge remote-tracking branch 'origin/master' into wordcloud-wip

f562fdd

# Conflicts: # .playground/playground.tsx # api/charts.api.md

chore: restored windows friendly settings

11e57ed

chore: ci is even more picky about import order

3ea1531

monfera marked this pull request as ready for review March 21, 2021 21:27

monfera changed the title ~~feat(wordcloud): wordcloud WIP~~ feat(wordcloud): wordcloud Mar 21, 2021

monfera removed the wip work in progress label Mar 21, 2021

test: post merge image update with common font

a0f5965

monfera requested a review from markov00 March 22, 2021 07:52

markov00 approved these changes Mar 22, 2021

View reviewed changes

monfera merged commit f08f4c9 into elastic:master Mar 22, 2021

Kati-dev-hu mentioned this pull request Mar 22, 2021

[Wordcloud] follow-up steps #1083

Closed

4 tasks

nickofthyme added the released Issue released publicly label Mar 23, 2021

monfera mentioned this pull request May 12, 2021

[Wordcloud] Replace kibana tagcloud with es-charts #1156

Closed

6 tasks

Conversation

Kati-dev-hu commented Feb 28, 2021 • edited by monfera Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

kibanamachine commented Feb 28, 2021

Uh oh!

cla-checker-service bot commented Feb 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markov00 commented Mar 5, 2021

Uh oh!

Kati-dev-hu commented Mar 9, 2021

Uh oh!

Kati-dev-hu commented Mar 9, 2021

Uh oh!

codecov-io commented Mar 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

monfera commented Mar 21, 2021

Uh oh!

monfera commented Mar 21, 2021

Uh oh!

markov00 left a comment

Choose a reason for hiding this comment

Uh oh!

markov00 Mar 22, 2021

Choose a reason for hiding this comment

Uh oh!

markov00 Mar 22, 2021

Choose a reason for hiding this comment

Uh oh!

markov00 Mar 22, 2021

Choose a reason for hiding this comment

Uh oh!

markov00 Mar 22, 2021

Choose a reason for hiding this comment

Uh oh!

Kati-dev-hu commented Mar 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nickofthyme commented Mar 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Kati-dev-hu commented Feb 28, 2021 •

edited by monfera

Loading

cla-checker-service bot commented Feb 28, 2021 •

edited

Loading

codecov-io commented Mar 21, 2021 •

edited

Loading

Kati-dev-hu commented Mar 22, 2021 •

edited

Loading