Show/Hide Empty Months feature

Adding the ability to initialize a figure with the option to hide months that have empty/NaN values

Author: cylinderStudio

Diff for: plotly_calplot/calplot.py

@@ -75,6 +75,7 @@ def calplot(
     start_month: int = 1,
     end_month: int = 12,
     date_fmt: str = "%Y-%m-%d",
+    show_empty_months: bool = True,
 ) -> go.Figure:
     """
     Yearly Calendar Heatmap
@@ -155,6 +156,9 @@ def calplot(
         date format for the date column in data, defaults to "%Y-%m-%d"
         If the date column is already in datetime format, this parameter
         will be ignored.
+
+    show_empty_months : bool = True
+        if True heatmaps will display months that have no data
     """
     data[x] = validate_date_column(data[x], date_fmt)
     unique_years = data[x].dt.year.unique()
@@ -199,9 +203,10 @@ def calplot(
 
     for i, year in enumerate(unique_years):
         selected_year_data = data.loc[data[x].dt.year == year]
-        selected_year_data = fill_empty_with_zeros(
-            selected_year_data, x, year, start_month, end_month
-        )
+        if show_empty_months:
+            selected_year_data = fill_empty_with_zeros(
+                selected_year_data, x, year, start_month, end_month
+            )
 
         year_calplot(
             selected_year_data,
@@ -224,6 +229,7 @@ def calplot(
             years_as_columns=years_as_columns,
             start_month=start_month,
             end_month=end_month,
+            show_empty_months=show_empty_months,
         )
 
     fig = apply_general_colorscaling(fig, cmap_min, cmap_max)

Diff for: plotly_calplot/date_extractors.py

@@ -2,18 +2,23 @@
 
 import numpy as np
 import pandas as pd
+import calendar
 
 
 def get_month_names(
-    data: pd.DataFrame, x: str, start_month: int = 1, end_month: int = 12
+    data: pd.DataFrame, x: str, start_month: int = 1, end_month: int = 12, show_empty_months = True
 ) -> List[str]:
-    start_month_names_filler = [None] * (start_month - 1)
-    end_month_names_filler = [None] * (12 - end_month)
-    month_names = list(
-        start_month_names_filler
-        + data[x].dt.month_name().unique().tolist()
-        + end_month_names_filler
-    )
+    if show_empty_months:
+        start_month_names_filler = [None] * (start_month - 1)
+        end_month_names_filler = [None] * (12 - end_month)
+        month_names = list(
+            start_month_names_filler
+            + data[x].dt.month_name().unique().tolist()
+            + end_month_names_filler
+        )
+    else:
+        month_names = list(calendar.month_name)[1:]    
+
     return month_names
 
 

Diff for: plotly_calplot/single_year_calplot.py

@@ -33,12 +33,13 @@ def year_calplot(
     years_as_columns: bool = False,
     start_month: int = 1,
     end_month: int = 12,
+    show_empty_months = True,
 ) -> go.Figure:
     """
     Each year is subplotted separately and added to the main plot
     """
 
-    month_names = get_month_names(data, x, start_month, end_month)
+    month_names = get_month_names(data, x, start_month, end_month, show_empty_months)
     month_positions, weekdays_in_year, weeknumber_of_dates = get_date_coordinates(
         data, x
     )