provide option to display totals on top of each bar #5375

wilhelmhb · 2021-01-06T08:52:17Z

This PR aims at allowing users to display the total of each bar on top of it (bottom of it for negative values).

TODO:

wilhelmhb · 2021-01-06T08:55:44Z

I haven't yet been able to run the tests, probably a browser/configuration issue. Thus I haven't started on the jasmine tests. I can provide a few test cases if needed.
I don't really see where the documentation is written, but if someone points me in the right direction, I'll be glad to add a few examples.

archmoj

Thanks very much for the PR.
Before adding tests, I suggest you sync the master branch of fork with the latest changes of plotly/plotly.js/master; then git merge upstream/master into this branch.
Please find my other comments below:

src/traces/bar/layout_attributes.js

src/traces/bar/plot.js

archmoj · 2021-01-06T13:31:42Z

src/traces/bar/layout_attributes.js

@@ -63,5 +63,17 @@ module.exports = {
            'Sets the gap (in plot fraction) between bars of',
            'the same location coordinate.'
        ].join(' ')
-    }
+    },
+    displaytotal: {


displaytotal is too general while this attribute lives in layout.
How about barshowtotal?

Much better indeed.
Should I also rename totaltemplate to bartotaltemplate, so that each bar specific option starts with bar ? Or do we want to reuse totaltemplate for area charts as well ?

src/traces/bar/layout_defaults.js

Contributes to plotly#85

Rename option Refactor code according to comments Contributes to plotly#85

wilhelmhb · 2021-03-09T08:42:27Z

Any update on this ?

nicolaskruchten · 2021-03-09T14:01:52Z

Thanks for this PR! Our team is currently working hard on finishing up the 2.0 release of Plotly.js which explains our radio-silence for the past while, and I apologize for not communicating more clearly about it. This PR should probably land in 2.1, which we expect to come out in April. I'm sorry for the long timelines here :)

mysheepb · 2021-10-12T05:58:35Z

I am interested in using this feature. Any update?

vovavili · 2022-03-15T13:28:33Z

@nicolaskruchten Hello! I am interested in using this feature. Now that we're reaching April 2022 and plotly 2.11, are there any updates on this PR?

archmoj · 2022-03-23T15:42:54Z

@vovavili could you please fetch upstream/master and merge it into this branch?

hjc0826 · 2022-05-23T10:21:30Z

I am interested in using this feature. Any update?

…-totals

wilhelmhb · 2022-07-13T16:31:51Z

@nicolaskruchten @archmoj I've just merged upstream/master in this branch
I removed a typo, and added an example in test/image/mocks/bar_stackrelative_negative_total.json, available when you run npm start, then lookup the filename in the mocks search field.

I personally have a weird result on my machine. However, as I have the same result when using any text with textposition : outside, I'm assuming this is an issue with plotly.js, which should be a separate matter.

I'm still unable to run the jasmine tests on my machine.

Hoping this can still make it to 2.13

hadarby · 2022-07-31T15:54:49Z

Hi there is any update?

archmoj · 2022-11-07T19:10:57Z

src/traces/bar/layout_attributes.js

+    barshowtotal: {
+        valType: 'boolean',
+        dflt: false,
+        role: 'style',


There is no longer role needed for attributes like this one.
Please remove the role: 'style', line.

archmoj · 2022-11-07T19:11:23Z

src/traces/bar/layout_attributes.js

+    totaltemplate: {
+        valType: 'string',
+        dflt: '%{total}',
+        role: 'style',


There is no longer role needed for attributes like this one.
Please remove the role: 'style', line.

archmoj · 2022-11-07T19:17:20Z

src/traces/bar/layout_attributes.js

+        editType: 'plot',
+        description: 'Display the total value of each bar.'
+    },
+    totaltemplate: {


We may want this attribute or a similar one to control hover.
It may be better to have

stackbartotal: { texttemplate: ..., hovertemplate: ... }

And there is no need for barshowtotal as it could be enabled by texttemplate.

archmoj · 2022-11-07T19:20:59Z

Thanks @wilhelmhb for the great PR.
My apologies for the late review.
Kindly find my comments regarding the new attributes.
Before adding new tests, I also suggest that you possibly pull upstream/master and merge it to your branch.
@alexcjohnson it would be great if you also provide a review. Thank you!

Pampelmops · 2023-10-12T10:08:10Z

October 2023, I could really use this feature. Thank you.

futurejohn · 2023-12-20T19:55:29Z

@archmoj @alexcjohnson How is the review going? It would be really helpful to display totals for bar charts.

archmoj · 2024-05-28T15:26:20Z

Would you please fetch upstream/master, merge it into this branch and resolve conflicts 🙏
We are hoping to include this feature.
Thank you!

archmoj reviewed Jan 6, 2021

View reviewed changes

archmoj added status: reviewable community community contribution feature something new labels Jan 6, 2021

wilhelmhb added 3 commits January 7, 2021 10:49

[Bars] Add possibility to display totals for bars

f99ee3b

Contributes to plotly#85

[Bars] Force text to be inside if total is to be displayed

9493050

Contributes to plotly#85

[Bars] Option to display totals on top of each bar

0743a99

Rename option Refactor code according to comments Contributes to plotly#85

wilhelmhb force-pushed the bar-totals branch from b9ea827 to 0743a99 Compare January 7, 2021 09:57

wilhelmhb changed the title ~~[WIP][Bars] Option to display totals on top of each bar~~ [Bars] Option to display totals on top of each bar Mar 9, 2021

archmoj added status: has TODOs and removed status: reviewable labels Mar 23, 2021

wilhelmhb added 3 commits July 13, 2022 12:14

Merge branch 'master' of https://github.com/plotly/plotly.js into bar…

0883ffd

…-totals

[Bars] Fix option name for displaying totals

66852fb

[Bars] Add test for displaying totals

db3d1d6

archmoj reviewed Nov 7, 2022

View reviewed changes

archmoj requested a review from alexcjohnson November 7, 2022 19:21

archmoj added the status: reviewable label Nov 7, 2022

gvwilson self-assigned this May 27, 2024

gvwilson removed their assignment Aug 2, 2024

gvwilson removed status: has TODOs labels Aug 8, 2024

gvwilson changed the title ~~[Bars] Option to display totals on top of each bar~~ Option to display totals on top of each bar Aug 8, 2024

gvwilson changed the title ~~Option to display totals on top of each bar~~ provide option to display totals on top of each bar Aug 9, 2024

gvwilson added the P2 considered for next cycle label Aug 9, 2024

gvwilson assigned marthacryan Aug 21, 2024

gvwilson unassigned marthacryan Nov 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

provide option to display totals on top of each bar #5375

provide option to display totals on top of each bar #5375

wilhelmhb commented Jan 6, 2021

wilhelmhb commented Jan 6, 2021

archmoj left a comment

archmoj Jan 6, 2021

wilhelmhb Jan 7, 2021

wilhelmhb commented Mar 9, 2021

nicolaskruchten commented Mar 9, 2021

mysheepb commented Oct 12, 2021

vovavili commented Mar 15, 2022

archmoj commented Mar 23, 2022

hjc0826 commented May 23, 2022

wilhelmhb commented Jul 13, 2022

hadarby commented Jul 31, 2022

archmoj Nov 7, 2022

archmoj Nov 7, 2022

archmoj Nov 7, 2022

archmoj commented Nov 7, 2022

Pampelmops commented Oct 12, 2023

futurejohn commented Dec 20, 2023

archmoj commented May 28, 2024

provide option to display totals on top of each bar #5375

Are you sure you want to change the base?

provide option to display totals on top of each bar #5375

Conversation

wilhelmhb commented Jan 6, 2021

wilhelmhb commented Jan 6, 2021

archmoj left a comment

Choose a reason for hiding this comment

archmoj Jan 6, 2021

Choose a reason for hiding this comment

wilhelmhb Jan 7, 2021

Choose a reason for hiding this comment

wilhelmhb commented Mar 9, 2021

nicolaskruchten commented Mar 9, 2021

mysheepb commented Oct 12, 2021

vovavili commented Mar 15, 2022

archmoj commented Mar 23, 2022

hjc0826 commented May 23, 2022

wilhelmhb commented Jul 13, 2022

hadarby commented Jul 31, 2022

archmoj Nov 7, 2022

Choose a reason for hiding this comment

archmoj Nov 7, 2022

Choose a reason for hiding this comment

archmoj Nov 7, 2022

Choose a reason for hiding this comment

archmoj commented Nov 7, 2022

Pampelmops commented Oct 12, 2023

futurejohn commented Dec 20, 2023

archmoj commented May 28, 2024