Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CalendarHeatmap documentation #5

Closed
oscarlofwenhamn opened this issue Jul 20, 2020 · 3 comments
Closed

Update CalendarHeatmap documentation #5

oscarlofwenhamn opened this issue Jul 20, 2020 · 3 comments

Comments

@oscarlofwenhamn
Copy link

oscarlofwenhamn commented Jul 20, 2020

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Performance issue
[ ] Feature request
[x] Documentation issue or request
[ ] Other... Please describe:

Current behavior

Using the current code and sample data from the CalendarHeatmap code at Reaviz Charts page gives the Error Uncaught TypeError: date.getFullYear is not a function. When instead passing the keys as Date objects, it renders. The docs and sample data should be updated to reflect this.

@oscarlofwenhamn
Copy link
Author

I could find the cached version of the same issue from the last repo with the following reply:

Hi @elimist3. This component actually requires Date instances to be passed as keys in the data. I forked your codesandbox here and converted the keys to date and it works:

https://codesandbox.io/s/reaviz-codesandbox-template-6ew0d

Seems to work in my case as well, but I reckon the docs can still do with an update reflecting this.

@oscarlofwenhamn oscarlofwenhamn changed the title Can't render CalendarHeatmap (TypeError: date.getFullYear is not a function) Update CalendarHeatmap documentation Jul 20, 2020
@amcdnl
Copy link
Member

amcdnl commented Jul 21, 2020

Can you verify if this works now?

@oscarlofwenhamn
Copy link
Author

Verified, sample data now works as-is, nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants