Preserve QExcell hidden rows and columns in XLSX

This commit is contained in:
Курнат Андрей
2026-06-01 20:17:50 +03:00
parent ae82652068
commit 3418725017
4 changed files with 149 additions and 10 deletions
+58
View File
@@ -25,6 +25,8 @@ import {
worksheetXmlToCellFormats,
worksheetXmlToColumnWidths,
worksheetXmlToFrozenPane,
worksheetXmlToHiddenColumns,
worksheetXmlToHiddenRows,
worksheetXmlToHyperlinks,
worksheetXmlToMergedCells,
worksheetXmlToRowHeights,
@@ -912,6 +914,62 @@ describe("excellOffice OOXML helpers", () => {
expect(imported.sheets[0].rowHeights).toEqual({ "1": 24, "4": 30.5 });
});
it("читает и записывает скрытые колонки и строки XLSX", async () => {
expect(
worksheetXmlToHiddenColumns({
worksheet: {
cols: {
col: [
{ min: "2", max: "3", hidden: "1" },
{ min: "5", max: "5", width: "12", hidden: "true" }
]
}
}
})
).toEqual({ B: true, C: true, E: true });
expect(
worksheetXmlToHiddenRows({
worksheet: {
sheetData: {
row: [{ r: "4", hidden: "1" }, { r: "6", ht: "21", hidden: "true" }]
}
}
})
).toEqual({ "4": true, "6": true });
expect(buildColumnWidthsXml({ E: 12 }, { B: true, C: true, E: true })).toBe(
'<cols><col min="2" max="2" hidden="1"/><col min="3" max="3" hidden="1"/><col min="5" max="5" width="12" customWidth="1" hidden="1"/></cols>'
);
const blob = await exportXlsxBlob({
id: "book-1",
title: "Hidden rows and columns.xlsx",
updatedAt: "2026-06-01T00:00:00.000Z",
activeSheet: "sheet-1",
sheets: [
{
id: "sheet-1",
name: "Hidden",
columnWidths: { E: 12 },
rowHeights: { "6": 21 },
hiddenColumns: { B: true, C: true, E: true },
hiddenRows: { "4": true, "6": true },
cells: { A1: "Visible" }
}
]
});
const zip = await JSZip.loadAsync(await blob.arrayBuffer());
const sheetXml = (await zip.file("xl/worksheets/sheet1.xml")?.async("string")) ?? "";
const imported = await importXlsxFile(new File([blob], "Hidden rows and columns.xlsx", { type: blob.type }));
expect(sheetXml).toContain(
'<cols><col min="2" max="2" hidden="1"/><col min="3" max="3" hidden="1"/><col min="5" max="5" width="12" customWidth="1" hidden="1"/></cols>'
);
expect(sheetXml).toContain('<row r="4" hidden="1"/>');
expect(sheetXml).toContain('<row r="6" ht="21" customHeight="1" hidden="1"/>');
expect(imported.sheets[0].hiddenColumns).toEqual({ B: true, C: true, E: true });
expect(imported.sheets[0].hiddenRows).toEqual({ "4": true, "6": true });
});
it("создает OOXML chart part для диаграммы XLSX", () => {
const xml = buildChartXml(
{
+87 -8
View File
@@ -14,6 +14,8 @@ export interface ImportedExcellWorkbook {
tabColor?: string;
columnWidths?: Record<string, number>;
rowHeights?: Record<string, number>;
hiddenColumns?: Record<string, boolean>;
hiddenRows?: Record<string, boolean>;
showGridLines?: boolean;
zoomScale?: number;
printArea?: string;
@@ -69,6 +71,8 @@ interface ParsedSheet {
tabColor?: string;
columnWidths?: Record<string, number>;
rowHeights?: Record<string, number>;
hiddenColumns?: Record<string, boolean>;
hiddenRows?: Record<string, boolean>;
showGridLines?: boolean;
zoomScale?: number;
printArea?: string;
@@ -291,6 +295,8 @@ export async function exportXlsxBlob(workbook: Workbook): Promise<Blob> {
sheet.tabColor,
sheet.columnWidths,
sheet.rowHeights,
sheet.hiddenColumns,
sheet.hiddenRows,
sheet.showGridLines,
sheet.zoomScale
)
@@ -330,6 +336,8 @@ export function parsedWorksheetToSheet(
const tabColor = worksheetXmlToTabColor(worksheetXml, themeColors);
const columnWidths = worksheetXmlToColumnWidths(worksheetXml);
const rowHeights = worksheetXmlToRowHeights(worksheetXml);
const hiddenColumns = worksheetXmlToHiddenColumns(worksheetXml);
const hiddenRows = worksheetXmlToHiddenRows(worksheetXml);
const showGridLines = worksheetXmlToShowGridLines(worksheetXml);
const zoomScale = worksheetXmlToZoomScale(worksheetXml);
@@ -342,6 +350,8 @@ export function parsedWorksheetToSheet(
...(tabColor ? { tabColor } : {}),
...(Object.keys(columnWidths).length > 0 ? { columnWidths } : {}),
...(Object.keys(rowHeights).length > 0 ? { rowHeights } : {}),
...(Object.keys(hiddenColumns).length > 0 ? { hiddenColumns } : {}),
...(Object.keys(hiddenRows).length > 0 ? { hiddenRows } : {}),
...(showGridLines === false ? { showGridLines } : {}),
...(zoomScale ? { zoomScale } : {}),
cells: worksheetXmlToCells(worksheetXml, sharedStrings),
@@ -514,6 +524,26 @@ export function worksheetXmlToColumnWidths(worksheetXml: unknown): Record<string
}, {});
}
export function worksheetXmlToHiddenColumns(worksheetXml: unknown): Record<string, boolean> {
const worksheet = childRecord(worksheetXml, "worksheet");
const cols = childRecord(worksheet, "cols");
return toArray(cols.col).reduce<Record<string, boolean>>((columns, col) => {
const record = asRecord(col);
const min = positiveIntegerAttribute(record.min);
const max = positiveIntegerAttribute(record.max) || min;
if (!min || !max || max < min || !booleanAttribute(record.hidden)) {
return columns;
}
for (let column = min; column <= max; column += 1) {
columns[columnName(column)] = true;
}
return columns;
}, {});
}
export function worksheetXmlToRowHeights(worksheetXml: unknown): Record<string, number> {
const worksheet = childRecord(worksheetXml, "worksheet");
const sheetData = childRecord(worksheet, "sheetData");
@@ -530,6 +560,21 @@ export function worksheetXmlToRowHeights(worksheetXml: unknown): Record<string,
}, {});
}
export function worksheetXmlToHiddenRows(worksheetXml: unknown): Record<string, boolean> {
const worksheet = childRecord(worksheetXml, "worksheet");
const sheetData = childRecord(worksheet, "sheetData");
return toArray(sheetData.row).reduce<Record<string, boolean>>((rows, row, index) => {
const record = asRecord(row);
const rowNumber = positiveIntegerAttribute(record.r) || index + 1;
if (booleanAttribute(record.hidden)) {
rows[String(rowNumber)] = true;
}
return rows;
}, {});
}
async function worksheetXmlToCharts(
zip: ZipInstance,
parser: InstanceType<XmlParserConstructor>,
@@ -706,10 +751,13 @@ export function buildWorksheetXml(
tabColor?: string,
columnWidths: Record<string, number> = {},
rowHeights: Record<string, number> = {},
hiddenColumns: Record<string, boolean> = {},
hiddenRows: Record<string, boolean> = {},
showGridLines?: boolean,
zoomScale?: number
) {
const normalizedRowHeights = normalizedSheetRowHeights(rowHeights);
const normalizedHiddenRows = normalizedSheetHiddenRows(hiddenRows);
const rows = sortedWorksheetEntries(cells, cellFormats).reduce<Record<number, Array<[string, string]>>>((grouped, entry) => {
const rowNumber = cellRowNumber(entry[0]);
if (!grouped[rowNumber]) {
@@ -724,11 +772,17 @@ export function buildWorksheetXml(
rows[row] = [];
}
});
Object.keys(normalizedHiddenRows).forEach((rowNumber) => {
const row = positiveIntegerAttribute(rowNumber);
if (row && !rows[row]) {
rows[row] = [];
}
});
const rowXml = Object.entries(rows)
.map(([rowNumber, entries]) => {
const cellXml = entries.map(([address, value]) => buildCellXml(address, value, cellStyleId(cellFormats[address], styleRegistry))).join("");
const rowAttributes = buildRowHeightAttributes(normalizedRowHeights[rowNumber]);
const rowAttributes = buildRowAttributes(normalizedRowHeights[rowNumber], normalizedHiddenRows[rowNumber]);
return cellXml ? `<row r="${rowNumber}"${rowAttributes}>${cellXml}</row>` : `<row r="${rowNumber}"${rowAttributes}/>`;
})
.join("");
@@ -739,7 +793,7 @@ export function buildWorksheetXml(
const drawingXml = drawingRelationshipId ? `<drawing r:id="${escapeXmlAttribute(drawingRelationshipId)}"/>` : "";
const sheetPrXml = buildSheetPrXml(tabColor);
const sheetViewsXml = buildSheetViewsXml(frozenPane, showGridLines, zoomScale);
const colsXml = buildColumnWidthsXml(columnWidths);
const colsXml = buildColumnWidthsXml(columnWidths, hiddenColumns);
return xmlDeclaration(
`<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">${sheetPrXml}${sheetViewsXml}${colsXml}<sheetData>${rowXml}</sheetData>${autoFilterXml}${mergeCellsXml}${hyperlinksXml}${drawingXml}</worksheet>`
@@ -835,16 +889,23 @@ export function buildSheetPrXml(tabColor?: string) {
return color ? `<sheetPr><tabColor rgb="FF${color}"/></sheetPr>` : "";
}
export function buildColumnWidthsXml(columnWidths: Record<string, number> = {}) {
const columns = normalizedSheetColumnWidths(columnWidths);
export function buildColumnWidthsXml(columnWidths: Record<string, number> = {}, hiddenColumns: Record<string, boolean> = {}) {
const columnsByNumber = new Map<number, { width?: number; hidden?: boolean }>();
normalizedSheetColumnWidths(columnWidths).forEach(({ column, width }) => {
columnsByNumber.set(column, { ...columnsByNumber.get(column), width });
});
normalizedSheetHiddenColumns(hiddenColumns).forEach((column) => {
columnsByNumber.set(column, { ...columnsByNumber.get(column), hidden: true });
});
const columns = Array.from(columnsByNumber.entries()).sort(([first], [second]) => first - second);
if (columns.length === 0) {
return "";
}
const xml = columns
.map(
({ column, width }) =>
`<col min="${column}" max="${column}" width="${formatSheetDimension(width)}" customWidth="1"/>`
([column, options]) =>
`<col min="${column}" max="${column}"${options.width ? ` width="${formatSheetDimension(options.width)}" customWidth="1"` : ""}${options.hidden ? ' hidden="1"' : ""}/>`
)
.join("");
@@ -1628,6 +1689,24 @@ function normalizedSheetRowHeights(rowHeights: Record<string, number> = {}) {
}, {});
}
function normalizedSheetHiddenColumns(hiddenColumns: Record<string, boolean> = {}) {
return Object.entries(hiddenColumns)
.map(([column, hidden]) => (hidden ? columnAddressNumber(column) : 0))
.filter((column, index, columns): column is number => Boolean(column) && columns.indexOf(column) === index)
.sort((first, second) => first - second);
}
function normalizedSheetHiddenRows(hiddenRows: Record<string, boolean> = {}) {
return Object.entries(hiddenRows).reduce<Record<string, boolean>>((rows, [row, hidden]) => {
const rowNumber = positiveIntegerAttribute(row);
if (rowNumber && hidden) {
rows[String(rowNumber)] = true;
}
return rows;
}, {});
}
function normalizedSheetZoomScale(value: unknown) {
const number = Number(value);
if (!Number.isFinite(number)) {
@@ -1638,8 +1717,8 @@ function normalizedSheetZoomScale(value: unknown) {
return zoomScale >= 10 && zoomScale <= 400 && zoomScale !== 100 ? zoomScale : 0;
}
function buildRowHeightAttributes(height?: number) {
return height ? ` ht="${formatSheetDimension(height)}" customHeight="1"` : "";
function buildRowAttributes(height?: number, hidden?: boolean) {
return `${height ? ` ht="${formatSheetDimension(height)}" customHeight="1"` : ""}${hidden ? ' hidden="1"' : ""}`;
}
function formatSheetDimension(value: number) {
+2
View File
@@ -24,6 +24,8 @@ export interface Sheet {
tabColor?: string;
columnWidths?: Record<string, number>;
rowHeights?: Record<string, number>;
hiddenColumns?: Record<string, boolean>;
hiddenRows?: Record<string, boolean>;
showGridLines?: boolean;
zoomScale?: number;
printArea?: string;