Enabled advanced tooltip text configuration and tooltip date format

[JoabMendes]

I was needing some extra configuration for the tooltip display and I added some advanced options in the library to enable it. (All the changes work along with the current version and doesn't change the current interface).

This PR will enable 3 new parameters:

• tooltipTextEnabled: Enables the advanced tooltip configuration (Overwrites any configuration done for tooltipUnit and tooltipEnabled).
• tooltipText: Enables any text to be specified for the tooltips. This options should be an object containing 3 properties: singular, plural and none. Each should have a string with the keys to be replaced by the actual item counting and dates, with the format: {count} and {date}. Example:

.tooltipText({
        plural: 'You sold {count} items on {date}',
        singular: 'You sold {count} item on {date}',
        none: 'No item was sold on {date}' // {count} isn't necessary in this one
})

• tooltipDateFormat: this allows the user to set a different date format for the tooltips.

.tooltipDateFormat('MM/DD/YYYY');

I updated the documentation, but English isn't my first language. So feel free to fix any typo or grammar mistake 😂.

I tested for both D3 versions and it works fine. Here is a demo using these new configurations.

[jzabroski]

This is a very nice summary, but, might I suggest allowing a TemplateSelector object to be passed in instead, and the default TemplateSelector be a ContributionsTemplateSelector and a non-default CustomPluralizationSelector. Or, just call it PluralizationSelector and have it be the base class to ContributionsTemplateSelector. The ultimate idea here is: why can't I display "fat tooltips" here with rich, active content inside the tooltip? For example, I once used this library to display day over day algorithmic trading performance at a brokerage. My thought was to then let the user select a two or more days and "compare" them to find hyperplanes of statistical significance. (It never got to this point because no one saw any value at all in data visualization to improve algorithms, a true shame.) With a generic TemplateSelector, I could put a select button in the tooltip. For example, select other days with similar performance within some tolerance threshold.

…

On Tue, Oct 2, 2018, 5:51 PM Joabe Mendes ***@***.***> wrote: I was needing some extra configuration for the tooltip display and I added some advanced options in the library to enable it. (All the changes work along with the current version and doesn't change the current interface). [image: screen shot 2018-10-02 at 5 07 02 pm] <https://user-images.githubusercontent.com/829669/46378902-1a4f3900-c66b-11e8-81af-3c795ed5b453.png> This PR will enable 3 new parameters: - *tooltipTextEnabled*: Enables the advanced tooltip configuration (Overwrites any configuration done for tooltipUnit and tooltipEnabled). - *tooltipText*: Enables any text to be specified for the tooltips. This options should be an object containing 3 properties: singular, plural and none. Each should have a string with the keys to be replaced by the actual item counting and dates, with the format: {count} and {date}. Example: .tooltipText({ plural: 'You sold {count} items on {date}', singular: 'You sold {count} item on {date}', none: 'No item was sold on {date}' // {count} isn't necessary in this one }) - *tooltipDateFormat*: this allows the user to set a different date format for the tooltips. .tooltipDateFormat('MM/DD/YYYY'); I updated the documentation, but English isn't my first language. So feel free to fix any typo or grammar mistake 😂. I tested for both D3 versions and it works fine. Here is a demo using these new configurations. [image: 2018-10-02 17 31 30] <https://user-images.githubusercontent.com/829669/46378886-0efc0d80-c66b-11e8-83aa-1f57a71b8778.gif> ------------------------------ You can view, comment on, or merge this pull request online at: #42 Commit Summary - Enabled advanced tooltip text configuration and tooltip date format File Changes - *A* .gitignore <https://github.com/DKirwan/calendar-heatmap/pull/42/files#diff-0> (1) - *M* README.md <https://github.com/DKirwan/calendar-heatmap/pull/42/files#diff-1> (18) - *M* example/_v4.html <https://github.com/DKirwan/calendar-heatmap/pull/42/files#diff-2> (8) - *M* src/calendar-heatmap.js <https://github.com/DKirwan/calendar-heatmap/pull/42/files#diff-3> (53) Patch Links: - https://github.com/DKirwan/calendar-heatmap/pull/42.patch - https://github.com/DKirwan/calendar-heatmap/pull/42.diff — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#42>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAbT_Tp8nURs5ZnR8_-275uDF8j3rUg4ks5ug9_HgaJpZM4XE7sN> .

[JoabMendes]

That's a cool idea, @jzabroski . Displaying rich contents on the tooltips like a popover would be awesome. But this PR came from a personal implementation and changing the text / date was all I needed. I might do a PR soon with that upgrade If I find the time. 🚀

[jzabroski]

Thank you very much for the kind words. It's always nice to receive words of appreciation for my unique thinking.