What is Wanikani Heatmap
This script adds a chart that shows which days you have reviewed and indicates with color how many reviews you did. Does the same with lessons. Along with this it also shows you some interesting stats such as how many days you have reviewed, how many reviews you do per day on average, and what your current streak is.
It utilises and is dependent on the Wanikani Open Framework to fetch the review data, so make sure it is installed.
What is WKOF
WKOF - Wanikani Open Framework - is a script by rfindley that makes it easier and more resource efficient to develop against the WK API. You need to install it and make it run before this script, for this one to work.
More information in this thread
Installing Wanikani Open Framework
The script will not show any review data since before 4 August 2017, because Wanikani did not log review data before that, but all lessons are included in your lesson heatmap.
You can also choose exactly which colors you want to use.
Works fine with dark themes.
For more heatmaps have a look at this thread
There are quite a few settings available for this script.
Start date: A manual start date in case you fell off the wagon years ago and want the script to ignore anything before a certain date.
First day of the week: Can be set to either Monday or Sunday with the default being determined by your timezone. It changes how the heatmap is laid out.
New day starts at: A setting to offset the start of a new day. Useful if you stay up late and want those hours after midnight to count to the previous day.
Reverse year order: Puts the most recent year on the bottom instead of on top.
Display intervals: Displays your chosen intervals right under the heatmap.
Segment year: Divides the years into months.
Day of week labels: Displays the days of the week as labels to the left of each row in the heatmaps.
Show level-up indicators: Puts a border around dates when you leveled up.
Color for level-up indicators: The color of the border for level-up indicators.
Show current day indicator: Puts a border around the current day.
Color for current day indicator: The color of the border of the current day indicator.
The following is the same for reviews and lessons.
Use these colors: Use the colors you have chosen. If unticked the default colors will be used.
Start color: The starting color of the gradient for the heatmap. This is the color for the first interval.
Color 2-4: Middle colors for the middle intervals.
End color: The end color of the gradient for the heatmap. This is also the color for the open-ended fifth interval.
Generate button: This button sets the middle colors based on your start and end colors, to create an even gradient.
Auto range: Automatically chooses the intervals based on how many reviews or lessons you have done in the past.
End of interval 1: Days with a number of items between 0 and this number will have the related color. Not including 0.
End of interval 2-4: Days with a number of items between the previous number and this will have the related color.
Interval 5: Not a setting. Days with more items than what is entered in End of interval 4 will have the fifth color.
Reload: Deletes cached data so that it can be refetched again. Mind that reloading review data can take a few minutes if you have a lot of reviews under your belt.
Forecast settings only apply to reviews
Show forecast: Show or hide the foercast part of the review heatmap.
Forecast color settings: Works just like the other color settings, but this applies only for the forecast part of the review heatmaps.
Special streak setting for lessons
- Count Zero Lesson Days: Count days on which you did no lesson but also had no lessons to do, towards the streak.
Planned features for 2.1.0:
- Click and drag between two dates to show stats in interval between them
- Time spent reviewing/doing lessons
- Number of review/lesson sessions
- Burn count in summaries
- Better tooltips in summaries
- More information for the items in the summaries
- Add color labels back, lol
- Indicator for which of the items were burned
- Cache review data! (found a way to do it in localStorage up to 400k reviews)
- Stops working in April 2019 in a specific timezone due to an unresolved bug in the heatmap library.
- Overflows the container on small screens
- Sometimes streaks read as 0 even though you didn’t break your streak