Skip to content

Disable subtotal line in groups #267

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Disable subtotal line in groups #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b806075
DisableSubtotalLine + correct style of grouped and merged cells
eagleoriginal Mar 27, 2022
7fe75e5
DisableSubtotalLine + correct style of grouped and merged cells
eagleoriginal Mar 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 32 additions & 13 deletions ClosedXML.Report/Excel/Subtotal.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,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,true);
gr = CreateGroup(Sheet.Range(rangeAddress), 1, 1, GrandLabel, summaries, false, true);
}
else
{
var rangeAddress = _range.RangeAddress;
_range.InsertRowsBelow(1, true);
gr = CreateGroup(Sheet.Range(rangeAddress), 1, 1, GrandLabel, summaries, false,true);
gr = CreateGroup(Sheet.Range(rangeAddress), 1, 1, GrandLabel, summaries, false, true);
}
gr.Column = 0;
_groups.Add(gr);
Expand Down Expand Up @@ -256,7 +256,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,bool isGrandTotal=false)
private SubtotalGroup CreateGroup(IXLRange groupRng, int groupClmn, int level, string title, SummaryFuncTag[] summaries, bool pageBreaks, bool isGrandTotal = false)
{
var firstRow = groupRng.RangeAddress.FirstAddress.RowNumber;
var lastRow = groupRng.RangeAddress.LastAddress.RowNumber;
Expand Down Expand Up @@ -351,18 +351,37 @@ private MoveData[] ScanRange(int groupBy)

var val = row.Cell(groupBy).GetString();
var isSummaryRow = row.IsSummary();
var isLeftGroupEndLine = false;
if (false == isSummaryRow)
{
isLeftGroupEndLine = _groups.SingleOrDefault(gr => gr.Column == groupBy - 1 &&
gr.SummaryRow == null &&
gr.Range.RangeAddress.LastAddress.RowNumber == row.RowNumber()) != null;
}

if (string.IsNullOrEmpty(val) && !isSummaryRow)
if (string.IsNullOrEmpty(val) && !isSummaryRow)
{
if (groupStart > 0)
{
if (groupStart > 0)
{
groups.Add(CreateMoveTask(groupBy, prevVal, _range.Cell(groupStart, 1), row.RowAbove().LastCell(), RangeType.DataRange));
}
groups.Add(CreateMoveTask(groupBy, "", row.FirstCell(), row.LastCell(), RangeType.HeaderRow));
prevVal = null;
groupStart = 0;
continue;
groups.Add(CreateMoveTask(groupBy, prevVal, _range.Cell(groupStart, 1), row.RowAbove().LastCell(), RangeType.DataRange));
}
groups.Add(CreateMoveTask(groupBy, "", row.FirstCell(), row.LastCell(), RangeType.HeaderRow));
prevVal = null;
groupStart = 0;
continue;
}

if (isLeftGroupEndLine)
{
var localGroupStart = groupStart == 0
? row.RangeAddress.Relative(_range.RangeAddress).FirstAddress.RowNumber
: groupStart;

groups.Add(CreateMoveTask(groupBy, prevVal, _range.Cell(localGroupStart, 1), row.LastCell(), RangeType.DataRange));
prevVal = null;
groupStart = 0;
continue;
}

if (val != prevVal)
{
Expand Down Expand Up @@ -392,7 +411,7 @@ private MoveData CreateMoveTask(int groupColumn, string title, IXLCell firstCell
{
var groupRng = _range.Range(firstCell, lastCell);
var level = firstCell.WorksheetRow().OutlineLevel;
var group = new MoveData(groupRng.RangeAddress, rangeType, title, level) {GroupColumn = groupColumn};
var group = new MoveData(groupRng.RangeAddress, rangeType, title, level) { GroupColumn = groupColumn };
return group;
}

Expand Down
29 changes: 22 additions & 7 deletions ClosedXML.Report/Options/GroupTag.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ OPTION PARAMS OBJECTS RNG Priority
"\PageBreaks"
"\TotalLabel"
"\GrandLabel"
"\DisableSubtotalLine"

"SummaryAbove" Range rD Normal

Expand Down Expand Up @@ -40,6 +41,7 @@ public class GroupTag : SortTag

public bool PageBreaks => Parameters.ContainsKey("pagebreaks");
public bool DisableSubtotals => Parameters.ContainsKey("disablesubtotals");
public bool DisableSubtotalLine => Parameters.ContainsKey("disablesubtotalline");
public bool Collapse => Parameters.ContainsKey("collapse");
public bool DisableOutLine => Parameters.ContainsKey("disableoutline");
public bool OutLine => !Parameters.ContainsKey("disableoutline");
Expand All @@ -63,7 +65,7 @@ public MergeMode MergeLabels
return _mergeLabels.Value;
}
}

private bool? _isWithHeader;
public bool IsWithHeader => (bool)(_isWithHeader ?? (_isWithHeader = Parameters.ContainsKey("withheader")));

Expand Down Expand Up @@ -114,7 +116,7 @@ private void Process(ProcessingContext context, GroupTag[] groups, bool summaryA
return;

var r = root.Offset(0, 0, rows, columns);

using (var subtotal = new Subtotal(r, summaryAbove, groups, context.Evaluator))
{
if (TotalLabel != null) subtotal.TotalLabel = TotalLabel;
Expand All @@ -129,15 +131,24 @@ private void Process(ProcessingContext context, GroupTag[] groups, bool summaryA

foreach (var g in groups.OrderBy(x => x.Column))
{
// Todo: New Feature Group Without Subtotal. Only Merge.
if (g.DisableSubtotalLine)
{
subtotal.ScanForGroups(g.Column);
g.Level = ++level;

continue;
}

Func<string, string> labFormat = null;
if (!string.IsNullOrEmpty(g.LabelFormat))
labFormat = title => string.Format(LabelFormat, title);

labFormat = title => string.Format(g.LabelFormat, title);
if (g.MergeLabels == MergeMode.Merge2 && summaries.Length == 0)
subtotal.ScanForGroups(g.Column);
else
subtotal.GroupBy(g.Column, g.DisableSubtotals ? new SummaryFuncTag[0] : summaries, g.PageBreaks, labFormat);

g.Level = ++level;
}

Expand Down Expand Up @@ -177,7 +188,7 @@ private static void FormatHeaderFooter(SubtotalGroup subGroup, IXLRangeRow group
subGroup.HeaderRow.CopyConditionalFormatsFrom(groupRow);

}

if (subGroup.SummaryRow != null)
{
foreach (var cell in groupRow.Cells(c => c.HasFormula && !(c.GetCellText()?.Contains("<<sum>>")??false)))
Expand Down Expand Up @@ -216,7 +227,11 @@ protected virtual void GroupRender(SubtotalGroup subGroup, GroupTag grData)
var rng = subGroup.Range.Column(subGroup.Column);
if (subGroup.Range.RowCount() > 1)
{
int cellIdx = _maxLevel - subGroup.Level + 1;
// TODO: Wrong Style apply for merged cells if on right has grouped total
// But in first cell i expect already cell with value and style
// Plus with DisableSubtotalLine feature this became totally wrong
int cellIdx = 1;
//int cellIdx = _maxLevel - subGroup.Level + 1; // TODO: Comment for future investigation
var style = rng.Cell(cellIdx).Style;
rng.Merge();
rng.Style = style;
Expand Down
3 changes: 2 additions & 1 deletion tests/ClosedXML.Report.Tests/GroupTagTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public void Simple(string templateFile)
{
using (var db = new DbDemos())
{
var cust = db.customers.LoadWith(x=>x.Orders.First().Items).OrderBy(c => c.CustNo).First(x=>x.CustNo == 1356);
var cust = db.customers.LoadWith(x=>x.Orders.First().Items).OrderBy(c => c.CustNo).First(x => x.CustNo == 1356);
cust.Logo = Resource.toms_diving_center;
tpl.AddVariable("MoreOrders", cust.Orders.Take(5));
tpl.AddVariable(cust);
Expand Down Expand Up @@ -78,6 +78,7 @@ public void EmptyDataSource(string templateFile)
InlineData("GroupTagTests_MultiRanges.xlsx"),
InlineData("GroupTagTests_FormulasWithTagsInGroupRow.xlsx"),
InlineData("GroupTagTests_TotalLabel.xlsx"),
InlineData("GroupTagTests_DisableSubTotals_MergeLabels.xlsx")
]
public void Customers(string templateFile)
{
Expand Down
Binary file added tests/Gauges/GroupTagTests_DisableSubTotals_MergeLabels.xlsx
View file
Open in desktop
Binary file not shown.
Binary file added tests/Templates/GroupTagTests_DisableSubTotals_MergeLabels.xlsx
View file
Open in desktop
Binary file not shown.