Add multiple levels totallabel support (#205)

* Add summary tag with label in group feature

* Add summary tag with label in group feature

* Add multiple levels totallabel feature

* Reformat

Author: zsu

ClosedXML.Report/Excel/Subtotal.cs

@@ -17,7 +17,7 @@ public class Subtotal : IDisposable
         private IXLWorksheet _tempSheet;
         private readonly List<SubtotalGroup> _groups = new List<SubtotalGroup>();
         public string TotalLabel { get; set; } = "Total";
-        public string GrandLabel { get; set; } = "Grand";
+        public string GrandLabel { get; set; } = "Grand Total";
 
         public Subtotal(IXLRange range) : this(range, false)
         {
@@ -40,7 +40,7 @@ public Subtotal(IXLRange range, bool summaryAbove)
 
         public SubtotalGroup[] Groups => _groups.ToArray();
 
-        public SubtotalGroup AddGrandTotal(SummaryFuncTag[] summaries)
+        public SubtotalGroup AddGrandTotal(GroupTag[] groups, SummaryFuncTag[] summaries)
         {
             if (Sheet.Row(_range.Row(2).RowNumber()).OutlineLevel == 0)
             {
@@ -49,13 +49,13 @@ public SubtotalGroup AddGrandTotal(SummaryFuncTag[] summaries)
                 {
                     var rangeAddress = _range.ShiftRows(1).RangeAddress;
                     _range.InsertRowsAbove(1, true);
-                    gr = CreateGroup(Sheet.Range(rangeAddress), 1, 1, GrandLabel, summaries, false);
+                    gr = CreateGroup(Sheet.Range(rangeAddress), 1, 1, GrandLabel, groups, summaries, false,true);
                 }
                 else
                 {
                     var rangeAddress = _range.RangeAddress;
                     _range.InsertRowsBelow(1, true);
-                    gr = CreateGroup(Sheet.Range(rangeAddress), 1, 1, GrandLabel, summaries, false);
+                    gr = CreateGroup(Sheet.Range(rangeAddress), 1, 1, GrandLabel, groups, summaries, false,true);
                 }
                 gr.Column = 0;
                 _groups.Add(gr);
@@ -64,7 +64,7 @@ public SubtotalGroup AddGrandTotal(SummaryFuncTag[] summaries)
             else return null;
         }
 
-        public void GroupBy(int groupBy, SummaryFuncTag[] summaries, bool pageBreaks = false, Func<string, string> getGroupLabel = null)
+        public void GroupBy(int groupBy, GroupTag[] groups, SummaryFuncTag[] summaries, bool pageBreaks = false, Func<string, string> getGroupLabel = null)
         {
             _pageBreaks = pageBreaks;
             _getGroupLabel = getGroupLabel;
@@ -87,7 +87,7 @@ public void GroupBy(int groupBy, SummaryFuncTag[] summaries, bool pageBreaks = f
             foreach (var moveData in grRanges)
             {
                 if (moveData.Type == RangeType.DataRange)
-                    _groups.Add(CreateGroup(Sheet.Range(moveData.TargetAddress), groupBy, level, moveData.GroupTitle, summaries, _pageBreaks));
+                    _groups.Add(CreateGroup(Sheet.Range(moveData.TargetAddress), groupBy, level, moveData.GroupTitle, groups, summaries, _pageBreaks));
             }
             ArrangePageBreaks(Groups, grRanges);
         }
@@ -252,7 +252,7 @@ private void MoveRange(MoveData moveData)
             Sheet.Cell(moveData.TargetAddress.FirstAddress).Value = _tempSheet.Range(1, 1, srcRng.RowCount(), srcRng.ColumnCount());
         }
 
-        private SubtotalGroup CreateGroup(IXLRange groupRng, int groupClmn, int level, string title, SummaryFuncTag[] summaries, bool pageBreaks)
+        private SubtotalGroup CreateGroup(IXLRange groupRng, int groupClmn, int level, string title, GroupTag[] groups, SummaryFuncTag[] summaries, bool pageBreaks,bool isGrandTotal=false)
         {
             var firstRow = groupRng.RangeAddress.FirstAddress.RowNumber;
             var lastRow = groupRng.RangeAddress.LastAddress.RowNumber;
@@ -272,7 +272,9 @@ private SubtotalGroup CreateGroup(IXLRange groupRng, int groupClmn, int level, s
             }
 
             summRow.Clear(XLClearOptions.Contents | XLClearOptions.DataType); //TODO Check if the issue persists (ClosedXML issue 844)
-            summRow.Cell(groupClmn).Value = _getGroupLabel != null ? _getGroupLabel(title) : title + " "+ TotalLabel;
+            //TODO: Remove the extra space if we can change the existing gauge files
+            //summRow.Cell(groupClmn).Value = _getGroupLabel != null ? _getGroupLabel(title) : title + (isGrandTotal?null: (string.IsNullOrWhiteSpace(groups?.Where(x => x.Column == groupClmn).Select(x => x.TotalLabel).FirstOrDefault())?null:" ") + (groups?.Where(x => x.Column == groupClmn).Select(x=>x.TotalLabel).FirstOrDefault()??TotalLabel));
+            summRow.Cell(groupClmn).Value = _getGroupLabel != null ? _getGroupLabel(title) : title + (isGrandTotal ? null : " " + (groups?.Where(x => x.Column == groupClmn).Select(x => x.TotalLabel).FirstOrDefault() ?? TotalLabel));
             Sheet.Row(summRow.RowNumber()).OutlineLevel = level - 1;
             foreach (var item in summaries)
             {

ClosedXML.Report/Excel/XlExtensions.cs

@@ -159,8 +159,8 @@ public static void Subtotal(this IXLRange range, int groupBy, string function, i
                 if (replace)
                     subtotal.Unsubtotal();
                 var summaries = totalList.Select(x => new SummaryFuncTag {Name=function.ToLower(), Cell = new TemplateCell { Column = x } }).ToArray();
-                subtotal.AddGrandTotal(summaries);
-                subtotal.GroupBy(groupBy, summaries, pageBreaks);
+                subtotal.AddGrandTotal(null, summaries);
+                subtotal.GroupBy(groupBy, null, summaries, pageBreaks);
             }
         }
 

ClosedXML.Report/Options/GroupTag.cs

@@ -121,7 +121,7 @@ private void Process(IXLRange root, GroupTag[] groups, bool summaryAbove,Summary
                 if (GrandLabel != null) subtotal.GrandLabel = GrandLabel;
                 if (!disableGrandTotal)
                 {
-                    var total = subtotal.AddGrandTotal(summaries);
+                    var total = subtotal.AddGrandTotal(groups, summaries);
                     total.SummaryRow.Cell(2).Value = total.SummaryRow.Cell(1).Value;
                     total.SummaryRow.Cell(1).Value = null;
                     level++;
@@ -136,7 +136,7 @@ private void Process(IXLRange root, GroupTag[] groups, bool summaryAbove,Summary
                     if (g.MergeLabels == MergeMode.Merge2 && funcs.Length == 0)
                         subtotal.ScanForGroups(g.Column);
                     else
-                        subtotal.GroupBy(g.Column, g.DisableSubtotals ? new SummaryFuncTag[0] : summaries, g.PageBreaks, labFormat);
+                        subtotal.GroupBy(g.Column, groups, g.DisableSubtotals ? new SummaryFuncTag[0] : summaries, g.PageBreaks, labFormat);
 
                     g.Level = ++level;
                 }

tests/ClosedXML.Report.Tests/GroupTagTests.cs

@@ -70,6 +70,7 @@ public void EmptyDataSource(string templateFile)
          InlineData("GroupTagTests_FormulasInGroupRow.xlsx"),
          InlineData("GroupTagTests_MultiRanges.xlsx"),
          InlineData("GroupTagTests_FormulasWithTagsInGroupRow.xlsx"),
+         InlineData("GroupTagTests_TotalLabel.xlsx"),
        ]
         public void Customers(string templateFile)
         {

tests/ClosedXML.Report.Tests/SubtotalTests.cs

@@ -91,9 +91,9 @@ public void WithHeaders()
             using (var subtotal = new Subtotal(_rng))
             {
                 var summaries = new[] { new SummaryFuncTag { Name = "sum", Cell=new TemplateCell { Column = 7 } } };//{new SubtotalSummaryFunc("sum", 7), };
-                subtotal.AddGrandTotal(summaries);
-                subtotal.GroupBy(2, summaries, true);
-                subtotal.GroupBy(3, summaries, true);
+                subtotal.AddGrandTotal(null, summaries);
+                subtotal.GroupBy(2, null, summaries, true);
+                subtotal.GroupBy(3, null, summaries, true);
                 subtotal.AddHeaders(2);
                 subtotal.AddHeaders(3);
             }