Add support for custom end date and start of week to heatmap

[janten]

Explanation About What Code Achieves:

This change creates two new attributes, end and start_monday, to the Heatmap class. end works just like start and start_monday can be set to 1 to have the weeks start on Monday, European style.

Screenshots/GIFs:

Steps To Test:

The docs have been added with an example, no further steps necessary.

TODOs:

None.

[viperfx]

How does the start variable work? I am having trouble using it.

I find this if I set start myself, with a JS Date object, it limits the number of months generated. It does not do +12 months.

[janten]

@viperfx Can you post the code you are using?

[viperfx]

Sure! FYI, I am using it with React, which support was adding in recently.

<Chart title="Test Graph" data={report.heatmap_data} start={new Date(report.start_date)} type="heatmap" discrete_domains={1}/>

the start variable would be something like this. 4 months before current date. I was hoping it would do +12 months of the start.

new Date("2017-07-10T22:45:34.136380+00:00")

[janten]

I have updated the code so it will default to a duration of one year if only one of start and end is provided. Could you try again?

[viperfx]

Sure. So I will need to npm install @ master right? Cause it looks the npm release was not made.

[viperfx]

On the topic of the heatmap, is it possible to add click handlers for each date right now? I can open a new issue for this if you like.

[janten]

This is just a pull request that has not been merged yet, I am not one of the official developers of this library. You can download a version containing my proposed changes from https://raw.githubusercontent.com/janten/charts/master/dist/frappe-charts.min.iife.js.

[pratu16x7]

@janten Glad this satisfies a missing widely-used property. Are there other week systems worth covering?

[janten]

@pratu16x7 I don't think so, at least none that I know of. Nevertheless, the change actually supports arbitrary days to start the week since it is interpreted as an offset. Setting start_monday = 2 would start the week on Tuesday but I cannot see anyone using it like that and found start_monday to be easier to grasp than start_dow.

[pratu16x7]

@janten Cool. We might then need labels for the days as well, for some visual difference between the two settings. Can you rebase the branch?

[GSLabIt]

What about to change start_monday variable name to first_day_of_week?

[bosue]

@pratu16x7 I don't think so, at least none that I know of. Nevertheless, the change actually supports arbitrary days to start the week since it is interpreted as an offset. Setting start_monday = 2 would start the week on Tuesday but I cannot see anyone using it like that and found start_monday to be easier to grasp than start_dow.

I see. However, from what I could find, in Bahrain, Egypt, Iraq, Jordan, Kuwait, Oman, Qatar, Saudi Arabia, Syria, the UAE, Yemen and probably a few more Islamic countries, the calendar week starts with Saturday and ends with Friday. I‘m not aware of any countries with calendar weeks starting on Tuesday, Wednesday, Thursday or Friday, though.

As there are three rather than two common manifestations of the „first day of the week“, we should definitely use a more neutral variable name than the quasi-boolean start_monday. Also, the Gregorian calendar starts with Monday, so I wonder, if Monday should be 0, Sunday 7 and Saturday 6?

All in all, this PR unfortunately has not been finished and merged in all these years, probably to a certain extent because these are two features rolled into one PR, though each of the two features requires quite a bit of discussion.

@janten: do you want to pick it up and detangle it into two tickets? Otherwise I would step forward and split it up, while mentioning you as the original author.